2.173.2

interface SynthesizeStackArtifactOptions

LanguageType name
.NETAmazon.CDK.SynthesizeStackArtifactOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2#SynthesizeStackArtifactOptions
Javasoftware.amazon.awscdk.SynthesizeStackArtifactOptions
Pythonaws_cdk.SynthesizeStackArtifactOptions
TypeScript (source)aws-cdk-lib » SynthesizeStackArtifactOptions

Stack artifact options.

A subset of cxschema.AwsCloudFormationStackProperties of optional settings that need to be configurable by synthesizers, plus additionalDependencies.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';

declare const assumeRoleAdditionalOptions: any;
const synthesizeStackArtifactOptions: cdk.SynthesizeStackArtifactOptions = {
  additionalDependencies: ['additionalDependencies'],
  assumeRoleAdditionalOptions: {
    assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,
  },
  assumeRoleArn: 'assumeRoleArn',
  assumeRoleExternalId: 'assumeRoleExternalId',
  bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',
  cloudFormationExecutionRoleArn: 'cloudFormationExecutionRoleArn',
  lookupRole: {
    arn: 'arn',

    // the properties below are optional
    assumeRoleAdditionalOptions: {
      assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,
    },
    assumeRoleExternalId: 'assumeRoleExternalId',
    bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',
    requiresBootstrapStackVersion: 123,
  },
  parameters: {
    parametersKey: 'parameters',
  },
  requiresBootstrapStackVersion: 123,
  stackTemplateAssetObjectUrl: 'stackTemplateAssetObjectUrl',
};

Properties

NameTypeDescription
additionalDependencies?string[]Identifiers of additional dependencies.
assumeRoleAdditionalOptions?{ [string]: any }Additional options to pass to STS when assuming the role for cloudformation deployments.
assumeRoleArn?stringThe role that needs to be assumed to deploy the stack.
assumeRoleExternalId?stringThe externalID to use with the assumeRoleArn.
bootstrapStackVersionSsmParameter?stringSSM parameter where the bootstrap stack version number can be found.
cloudFormationExecutionRoleArn?stringThe role that is passed to CloudFormation to execute the change set.
lookupRole?BootstrapRoleThe role to use to look up values from the target AWS account.
parameters?{ [string]: string }Values for CloudFormation stack parameters that should be passed when the stack is deployed.
requiresBootstrapStackVersion?numberVersion of bootstrap stack required to deploy this stack.
stackTemplateAssetObjectUrl?stringIf the stack template has already been included in the asset manifest, its asset URL.

additionalDependencies?

Type: string[] (optional, default: No additional dependencies)

Identifiers of additional dependencies.

assumeRoleAdditionalOptions?

Type: { [string]: any } (optional, default: No additional options.)

Additional options to pass to STS when assuming the role for cloudformation deployments.

  • RoleArn should not be used. Use the dedicated assumeRoleArn property instead.
  • ExternalId should not be used. Use the dedicated assumeRoleExternalId instead.
  • TransitiveTagKeys defaults to use all keys (if any) specified in Tags. E.g, all tags are transitive by default.

See also: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/STS.html#assumeRole-property

assumeRoleArn?

Type: string (optional, default: No role is assumed (current credentials are used))

The role that needs to be assumed to deploy the stack.

assumeRoleExternalId?

Type: string (optional, default: No externalID is used)

The externalID to use with the assumeRoleArn.

bootstrapStackVersionSsmParameter?

Type: string (optional, default: Bootstrap stack version number looked up)

SSM parameter where the bootstrap stack version number can be found.

Only used if requiresBootstrapStackVersion is set.

  • If this value is not set, the bootstrap stack name must be known at deployment time so the stack version can be looked up from the stack outputs.
  • If this value is set, the bootstrap stack can have any name because we won't need to look it up.

cloudFormationExecutionRoleArn?

Type: string (optional, default: No role is passed (currently assumed role/credentials are used))

The role that is passed to CloudFormation to execute the change set.

lookupRole?

Type: BootstrapRole (optional, default: None)

The role to use to look up values from the target AWS account.

parameters?

Type: { [string]: string } (optional, default: No parameters)

Values for CloudFormation stack parameters that should be passed when the stack is deployed.

requiresBootstrapStackVersion?

Type: number (optional, default: No bootstrap stack required)

Version of bootstrap stack required to deploy this stack.

stackTemplateAssetObjectUrl?

Type: string (optional, default: Not uploaded yet, upload just before deploying)

If the stack template has already been included in the asset manifest, its asset URL.

← PreviousNext →