aws-cdk

constructor

constructor(source: BootstrapSource);

method bootstrapEnvironment

bootstrapEnvironment: (
    environment: cxapi.Environment,
    sdkProvider: SdkProvider,
    options?: BootstrapEnvironmentOptions
) => Promise<DeployStackResult>;

method showTemplate

showTemplate: (json: boolean) => Promise<void>;

constructor

constructor(
    _credentials: AWS.Credentials,
    region: string,
    httpOptions?: ConfigurationOptions,
    sdkOptions?: SdkOptions
);

property currentRegion

readonly currentRegion: string;

method appendCustomUserAgent

appendCustomUserAgent: (userAgentData?: string) => void;

method appsync

appsync: () => AWS.AppSync;

method cloudFormation

cloudFormation: () => AWS.CloudFormation;

method cloudWatchLogs

cloudWatchLogs: () => AWS.CloudWatchLogs;

method codeBuild

codeBuild: () => AWS.CodeBuild;

method currentAccount

currentAccount: () => Promise<Account>;

method currentCredentials

currentCredentials: () => Promise<AWS.Credentials>;

• Return the current credentials

  Don't use -- only used to write tests around assuming roles.

method ec2

ec2: () => AWS.EC2;

method ecr

ecr: () => AWS.ECR;

method ecs

ecs: () => AWS.ECS;

method elbv2

elbv2: () => AWS.ELBv2;

method forceCredentialRetrieval

forceCredentialRetrieval: () => Promise<void>;

• Force retrieval of the current credentials

  Relevant if the current credentials are AssumeRole credentials -- do the actual lookup, and translate any error into a useful error message (taking into account credential provenance).

method getEndpointSuffix

getEndpointSuffix: (region: string) => string;

method iam

iam: () => AWS.IAM;

method kms

kms: () => AWS.KMS;

method lambda

lambda: () => AWS.Lambda;

method removeCustomUserAgent

removeCustomUserAgent: (userAgentData: string) => void;

method route53

route53: () => AWS.Route53;

method s3

s3: () => AWS.S3;

method secretsManager

secretsManager: () => AWS.SecretsManager;

method ssm

ssm: () => AWS.SSM;

method stepFunctions

stepFunctions: () => AWS.StepFunctions;

method validateCredentials

validateCredentials: () => Promise<void>;

• Make sure the the current credentials are not expired

constructor

constructor(
    defaultChain: AWS.CredentialProviderChain,
    defaultRegion: string,
    sdkOptions?: ConfigurationOptions
);

property defaultRegion

readonly defaultRegion: string;

• Default region

method baseCredentialsPartition

baseCredentialsPartition: (
    environment: cxapi.Environment,
    mode: Mode
) => Promise<string | undefined>;

• Return the partition that base credentials are for

  Returns undefined if there are no base credentials.

method defaultAccount

defaultAccount: () => Promise<Account | undefined>;

• The account we'd auth into if we used default credentials.

  Default credentials are the set of ambiently configured credentials using one of the environment variables, or ~/.aws/credentials, or the *one* profile that was passed into the CLI.

  Might return undefined if there are no default/ambient credentials available (in which case the user should better hope they have credential plugins configured).

  Uses a cache to avoid STS calls if we don't need 'em.

method forEnvironment

forEnvironment: (
    environment: cxapi.Environment,
    mode: Mode,
    options?: CredentialsOptions,
    quiet?: boolean
) => Promise<SdkForEnvironment>;

• Return an SDK which can do operations in the given environment

  The environment parameter is resolved first (see resolveEnvironment()).

method resolveEnvironment

resolveEnvironment: (env: cxapi.Environment) => Promise<cxapi.Environment>;

• Resolve the environment for a stack

  Replaces the magic values UNKNOWN_REGION and UNKNOWN_ACCOUNT with the defaults for the current SDK configuration (~/.aws/config or otherwise).

  It is an error if UNKNOWN_ACCOUNT is used but the user hasn't configured any SDK credentials.

method withAwsCliCompatibleDefaults

static withAwsCliCompatibleDefaults: (
    options?: SdkProviderOptions
) => Promise<SdkProvider>;

• Create a new SdkProvider which gets its defaults in a way that behaves like the AWS CLI does

  The AWS SDK for JS behaves slightly differently from the AWS CLI in a number of ways; see the class AwsCliCompatible for the details.

constructor

constructor();

property bootstrapStack

abstract readonly bootstrapStack: CloudFormationStack;

property bucketName

abstract readonly bucketName: string;

property bucketUrl

abstract readonly bucketUrl: string;

property found

abstract readonly found: boolean;

property stackName

abstract readonly stackName: string;

property variant

abstract readonly variant: string;

property version

abstract readonly version: number;

method bootstrapStackLookupError

static bootstrapStackLookupError: (stackName: string, e: Error) => ToolkitInfo;

method bootstrapStackNotFoundInfo

static bootstrapStackNotFoundInfo: (stackName: string) => ToolkitInfo;

method determineName

static determineName: (overrideName?: string) => string;

method fromStack

static fromStack: (stack: CloudFormationStack) => ToolkitInfo;

method lookup

static lookup: (
    environment: cxapi.Environment,
    sdk: ISDK,
    stackName: string | undefined
) => Promise<ToolkitInfo>;

property accountId

readonly accountId: string;

• The account number

property partition

readonly partition: string;

• The partition ('aws' or 'aws-cn' or otherwise)

property execute

readonly execute?: boolean;

• Whether to execute the changeset or only create it and leave it in review. true

property force

readonly force?: boolean;

property parameters

readonly parameters?: BootstrappingParameters;

property roleArn

readonly roleArn?: string;

property tags

readonly tags?: Tag[];

• Tags for cdktoolkit stack.

  - None.

property terminationProtection

readonly terminationProtection?: boolean;

• Whether the stacks created by the bootstrap process should be protected from termination.

  See Also

  • https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html true

property toolkitStackName

readonly toolkitStackName?: string;

property usePreviousParameters

usePreviousParameters?: boolean;

• Use previous values for unspecified parameters

  If not set, all parameters must be specified for every deployment.

  true

property bucketName

readonly bucketName?: string;

• The name to be given to the CDK Bootstrap bucket.

  - a name is generated by CloudFormation.

property cloudFormationExecutionPolicies

readonly cloudFormationExecutionPolicies?: string[];

• The ARNs of the IAM managed policies that should be attached to the role performing CloudFormation deployments. In most cases, this will be the AdministratorAccess policy. At least one policy is required if trustedAccounts were passed.

  - the role will have no policies attached

property createCustomerMasterKey

readonly createCustomerMasterKey?: boolean;

• Whether or not to create a new customer master key (CMK)

  Only applies to modern bootstrapping. Legacy bootstrapping will never create a CMK, only use the default S3 key.

  false

property customPermissionsBoundary

readonly customPermissionsBoundary?: string;

• Name for the customer's custom permissions boundary for bootstrapping

  - No value, optional argument

property examplePermissionsBoundary

readonly examplePermissionsBoundary?: boolean;

• Flag for using the default permissions boundary for bootstrapping

  - No value, optional argument

property kmsKeyId

readonly kmsKeyId?: string;

• The ID of an existing KMS key to be used for encrypting items in the bucket.

  - use the default KMS key or create a custom one

property publicAccessBlockConfiguration

readonly publicAccessBlockConfiguration?: boolean;

• Whether or not to enable S3 Staging Bucket Public Access Block Configuration

  true

property qualifier

readonly qualifier?: string;

• Identifier to distinguish multiple bootstrapped environments

  - Default qualifier

property trustedAccounts

readonly trustedAccounts?: string[];

• The list of AWS account IDs that are trusted to deploy into the environment being bootstrapped.

  - only the bootstrapped account can deploy into this environment

property trustedAccountsForLookup

readonly trustedAccountsForLookup?: string[];

• The list of AWS account IDs that are trusted to look up values in the environment being bootstrapped.

  - only the bootstrapped account can look up values in this environment

property changeSetName

readonly changeSetName?: string;

• Optional name to use for the CloudFormation change set. If not provided, a name will be generated automatically.

property execute

readonly execute?: boolean;

• Whether to execute the changeset or leave it in review.

  true

property method

readonly method: 'change-set';

property assumeRoleArn

readonly assumeRoleArn?: string;

• The ARN of the role that needs to be assumed, if any

property assumeRoleExternalId

readonly assumeRoleExternalId?: string;

• External ID required to assume the given role.

property assetParallelism

readonly assetParallelism?: boolean;

• Whether to build/publish assets in parallel

  true To remain backward compatible.

property ci

readonly ci?: boolean;

• Whether we are on a CI system

  false

property deploymentMethod

readonly deploymentMethod?: DeploymentMethod;

• What deployment method to use

  - Change set with defaults

property deployName

readonly deployName?: string;

• Name to deploy the stack under

  - Name from assembly

property envResources

readonly envResources: EnvironmentResources;

• Information about the bootstrap stack found in the target environment

property extraUserAgent

readonly extraUserAgent?: string;

• The extra string to append to the User-Agent header when performing AWS SDK calls.

  - nothing extra is appended to the User-Agent header

property force

readonly force?: boolean;

• Deploy even if the deployed template is identical to the one we are about to deploy. false

property hotswap

readonly hotswap?: HotswapMode;

property notificationArns

readonly notificationArns?: string[];

• Notification ARNs to pass to CloudFormation to notify when the change set has completed

  - No notifications

property overrideTemplate

readonly overrideTemplate?: any;

• If present, use this given template instead of the stored one

  - Use the stored template

property parameters

readonly parameters?: {
    [name: string]: string | undefined;
};

• The collection of extra parameters (in addition to those used for assets) to pass to the deployed template. Note that parameters with undefined or empty values will be ignored, and not passed to the template.

  - no additional parameters will be passed to the template

property progress

readonly progress?: StackActivityProgress;

• Display mode for stack deployment progress.

  StackActivityProgress.Bar stack events will be displayed for the resource currently being deployed.

property quiet

readonly quiet?: boolean;

• Quiet or verbose deployment

  false

property resolvedEnvironment

readonly resolvedEnvironment: cxapi.Environment;

• The environment to deploy this stack in

  The environment on the stack artifact may be unresolved, this one must be resolved.

property resourcesToImport

readonly resourcesToImport?: ResourcesToImport;

• If set, change set of type IMPORT will be created, and resourcesToImport passed to it.

property reuseAssets

readonly reuseAssets?: string[];

• List of asset IDs which shouldn't be built

  - Build all assets

property roleArn

readonly roleArn?: string;

• Role to pass to CloudFormation to execute the change set

  - Role specified on stack, otherwise current

property rollback

readonly rollback?: boolean;

• Rollback failed deployments

  true

property sdk

readonly sdk: ISDK;

• The SDK to use for deploying the stack

  Should have been initialized with the correct role with which stack operations should be performed.

property sdkProvider

readonly sdkProvider: SdkProvider;

• SDK provider (seeded with default credentials)

  Will exclusively be used to assume publishing credentials (which must start out from current credentials regardless of whether we've assumed an action role to touch the stack or not).

  Used for the following purposes:

  - Publish legacy assets. - Upload large CloudFormation templates to the staging bucket.

property stack

readonly stack: cxapi.CloudFormationStackArtifact;

• The stack to be deployed

property tags

readonly tags?: Tag[];

• Tags to pass to CloudFormation to add to stack

  - No tags

property usePreviousParameters

readonly usePreviousParameters?: boolean;

• Use previous values for unspecified parameters

  If not set, all parameters must be specified for every deployment.

  false

property noOp

readonly noOp: boolean;

property outputs

readonly outputs: {
    [name: string]: string;
};

property stackArn

readonly stackArn: string;

property ci

ci?: boolean;

property deployName

deployName?: string;

property quiet

quiet?: boolean;

property roleArn

roleArn?: string;

property sdk

sdk: ISDK;

property stack

stack: cxapi.CloudFormationStackArtifact;

• The stack to be destroyed

property method

readonly method: 'direct';

property endpoint

endpoint: string;

property password

password: string;

property username

username: string;

property repositoryUri

repositoryUri: string;

property currentRegion

readonly currentRegion: string;

• The region this SDK has been instantiated for

  (As distinct from the defaultRegion() on SdkProvider which represents the region configured in the default config).

method appendCustomUserAgent

appendCustomUserAgent: (userAgentData?: string) => void;

• Appends the given string as the extra information to put into the User-Agent header for any requests invoked by this SDK. If the string is 'undefined', this method has no effect.

method appsync

appsync: () => AWS.AppSync;

method cloudFormation

cloudFormation: () => AWS.CloudFormation;

method cloudWatchLogs

cloudWatchLogs: () => AWS.CloudWatchLogs;

method codeBuild

codeBuild: () => AWS.CodeBuild;

method currentAccount

currentAccount: () => Promise<Account>;

• The Account this SDK has been instantiated for

  (As distinct from the defaultAccount() on SdkProvider which represents the account available by using default credentials).

method ec2

ec2: () => AWS.EC2;

method ecr

ecr: () => AWS.ECR;

method ecs

ecs: () => AWS.ECS;

method elbv2

elbv2: () => AWS.ELBv2;

method getEndpointSuffix

getEndpointSuffix: (region: string) => string;

method iam

iam: () => AWS.IAM;

method kms

kms: () => AWS.KMS;

method lambda

lambda: () => AWS.Lambda;

method removeCustomUserAgent

removeCustomUserAgent: (userAgentData: string) => void;

• Removes the given string from the extra User-Agent header data used for requests invoked by this SDK.

method route53

route53: () => AWS.Route53;

method s3

s3: () => AWS.S3;

method secretsManager

secretsManager: () => AWS.SecretsManager;

method ssm

ssm: () => AWS.SSM;

method stepFunctions

stepFunctions: () => AWS.StepFunctions;

property didAssumeRole

readonly didAssumeRole: boolean;

• Whether or not the assume role was successful. If the assume role was not successful (false) then that means that the 'sdk' returned contains the default credentials (not the assume role credentials)

property sdk

readonly sdk: ISDK;

• The SDK for the given environment

property caBundlePath

readonly caBundlePath?: string;

• A path to a certificate bundle that contains a cert to be trusted.

  No certificate bundle

property proxyAddress

readonly proxyAddress?: string;

• Proxy address to use

  No proxy

property userAgent

readonly userAgent?: string;

• The custom user agent to use.

  - /

property assumeRoleCredentialsSourceDescription

readonly assumeRoleCredentialsSourceDescription?: string;

• Additional descriptive strings that indicate where the "AssumeRole" credentials are coming from

  Will be printed in an error message to help users diagnose auth problems.

property containerCreds

readonly containerCreds?: boolean;

• Whether we should check for container credentials

  - Autodetect

property ec2creds

readonly ec2creds?: boolean;

• Whether we should check for EC2 credentials

  - Autodetect

property httpOptions

readonly httpOptions?: SdkHttpOptions;

• HTTP options for SDK

property profile

readonly profile?: string;

• Profile to read from ~/.aws

  - No profile

member ForReading

ForReading = 0

member ForWriting

ForWriting = 1