AwsCredentialsAccountModuleSchema

AwsCredentialsAccountModuleSchema is the input schema for the AwsCredentialsAccountModule module. This schema defines the required and optional inputs for setting up a credentials-based AWS account using explicit AWS credentials for authentication.

@group

Modules/Account/AwsCredentialsAccount

@see

AwsCredentialsAccountModule to learn more about the AwsCredentialsAccountModule module.

Index

Properties

• accountId
• app
• credentials
• endpoint

Properties

accountId

accountId: string = ...

The AWS account ID that these credentials belong to. This is validated against the actual account ID returned by AWS STS to ensure credential validity.

app

app: App = ...

The App instance that this account will be associated with. This establishes the parent-child relationship between the app and the account.

credentials

credentials: { accessKeyId: string; secretAccessKey: string } = ...

The AWS credentials object containing the access key ID and secret access key. These credentials are used for authenticating with AWS services. Both accessKeyId and secretAccessKey are required and must be valid AWS credentials.

---

Type declaration

• accessKeyId: string

• secretAccessKey: string

optionalendpoint

endpoint?: null | string = ...

Optional custom endpoint URL for AWS services. This is useful for testing with LocalStack or other AWS-compatible services. When not provided, the default AWS endpoints will be used.