AwsCredentialsAccountModule

AwsCredentialsAccountModule is a credentials-based AWS account module that provides an implementation for the Account model. This module allows you to configure AWS account access using explicit AWS credentials (Access Key ID and Secret Access Key). It supports both real AWS accounts and custom endpoints for testing environments.

@example

TypeScript

import { AwsCredentialsAccountModule } from '@quadnix/octo-aws-cdk/modules/account/aws-credentials-account';

octo.loadModule(AwsCredentialsAccountModule, 'my-account-module', {
  accountId: '123456789012',
  app: myApp,
  credentials: {
    accessKeyId: 'EXAMPLE_KEY',
    secretAccessKey: 'EXAMPLE_SECRET'
  },
  endpoint: 'https://s3.amazonaws.com' // Optional
});

@group

Modules/Account/AwsCredentialsAccount

@see

• AwsCredentialsAccountModuleSchema for the input schema.
• AModule to learn more about modules.
• Account to learn more about the Account model.

Hierarchy

• unknown<AwsCredentialsAccountModuleSchema, AwsCredentialsAccount>
  • AwsCredentialsAccountModule

Index

Constructors

• constructor

Methods

• onInit

Constructors

constructor

• AwsCredentialsAccountModule(): AwsCredentialsAccountModule

• Inherited from AModule<AwsCredentialsAccountModuleSchema, AwsCredentialsAccount>.constructor

  Returns AwsCredentialsAccountModule

Methods

onInit

• onInit(inputs: AwsCredentialsAccountModuleSchema): Promise<AwsCredentialsAccount>

• Parameters

  • inputs: AwsCredentialsAccountModuleSchema

  Returns Promise<AwsCredentialsAccount>