Interface ISynthesizeStackArtifactOptions

Namespace

Amazon.CDK

Assembly

Amazon.CDK.dll

Stack artifact options.

public interface ISynthesizeStackArtifactOptions

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK;
             var synthesizeStackArtifactOptions = new SynthesizeStackArtifactOptions {
                 AdditionalDependencies = new [] { "additionalDependencies" },
                 AssumeRoleArn = "assumeRoleArn",
                 AssumeRoleExternalId = "assumeRoleExternalId",
                 BootstrapStackVersionSsmParameter = "bootstrapStackVersionSsmParameter",
                 CloudFormationExecutionRoleArn = "cloudFormationExecutionRoleArn",
                 LookupRole = new BootstrapRole {
                     Arn = "arn",

                     // the properties below are optional
                     AssumeRoleExternalId = "assumeRoleExternalId",
                     BootstrapStackVersionSsmParameter = "bootstrapStackVersionSsmParameter",
                     RequiresBootstrapStackVersion = 123
                 },
                 Parameters = new Dictionary<string, string> {
                     { "parametersKey", "parameters" }
                 },
                 RequiresBootstrapStackVersion = 123,
                 StackTemplateAssetObjectUrl = "stackTemplateAssetObjectUrl"
             };

Remarks

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

ExampleMetadata: fixture=_generated

Properties

AdditionalDependencies

Identifiers of additional dependencies.

string[]? AdditionalDependencies { get; }

Property Value

string[]

Remarks

Default: - No additional dependencies

AssumeRoleArn

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

string? AssumeRoleArn { get; }

Property Value

string

Remarks

Default: - No role is assumed (current credentials are used)

AssumeRoleExternalId

The externalID to use with the assumeRoleArn.

string? AssumeRoleExternalId { get; }

Property Value

string

Remarks

Default: - No externalID is used

BootstrapStackVersionSsmParameter

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

string? BootstrapStackVersionSsmParameter { get; }

Property Value

string

Remarks

Only used if requiresBootstrapStackVersion is set.

Default: - Bootstrap stack version number looked up

CloudFormationExecutionRoleArn

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

string? CloudFormationExecutionRoleArn { get; }

Property Value

string

Remarks

Default: - No role is passed (currently assumed role/credentials are used)

LookupRole

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

IBootstrapRole? LookupRole { get; }

Property Value

IBootstrapRole

Remarks

Default: - None

Parameters

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

IDictionary<string, string>? Parameters { get; }

Property Value

IDictionary<string, string>

Remarks

Default: - No parameters

RequiresBootstrapStackVersion

Version of bootstrap stack required to deploy this stack.

double? RequiresBootstrapStackVersion { get; }

Property Value

double?

Remarks

Default: - No bootstrap stack required

StackTemplateAssetObjectUrl

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

string? StackTemplateAssetObjectUrl { get; }

Property Value

string

Remarks

Default: - Not uploaded yet, upload just before deploying