Class SynthesizeStackArtifactOptions
Stack artifact options.
Inheritance
Implements
Namespace: Amazon.CDK
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class SynthesizeStackArtifactOptions : Object, ISynthesizeStackArtifactOptions
Syntax (vb)
Public Class SynthesizeStackArtifactOptions
Inherits Object
Implements ISynthesizeStackArtifactOptions
Remarks
A subset of cxschema.AwsCloudFormationStackProperties
of optional settings that need to be
configurable by synthesizers, plus additionalDependencies
.
ExampleMetadata: fixture=_generated
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"
};
Synopsis
Constructors
SynthesizeStackArtifactOptions() |
Properties
AdditionalDependencies | Identifiers of additional dependencies. |
AssumeRoleArn | The role that needs to be assumed to deploy the stack. |
AssumeRoleExternalId | The externalID to use with the assumeRoleArn. |
BootstrapStackVersionSsmParameter | SSM parameter where the bootstrap stack version number can be found. |
CloudFormationExecutionRoleArn | The role that is passed to CloudFormation to execute the change set. |
LookupRole | The role to use to look up values from the target AWS account. |
Parameters | Values for CloudFormation stack parameters that should be passed when the stack is deployed. |
RequiresBootstrapStackVersion | Version of bootstrap stack required to deploy this stack. |
StackTemplateAssetObjectUrl | If the stack template has already been included in the asset manifest, its asset URL. |
Constructors
SynthesizeStackArtifactOptions()
public SynthesizeStackArtifactOptions()
Properties
AdditionalDependencies
Identifiers of additional dependencies.
public string[] AdditionalDependencies { get; set; }
Property Value
System.String[]
Remarks
Default: - No additional dependencies
AssumeRoleArn
The role that needs to be assumed to deploy the stack.
public string AssumeRoleArn { get; set; }
Property Value
System.String
Remarks
Default: - No role is assumed (current credentials are used)
AssumeRoleExternalId
The externalID to use with the assumeRoleArn.
public string AssumeRoleExternalId { get; set; }
Property Value
System.String
Remarks
Default: - No externalID is used
BootstrapStackVersionSsmParameter
SSM parameter where the bootstrap stack version number can be found.
public string BootstrapStackVersionSsmParameter { get; set; }
Property Value
System.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.
public string CloudFormationExecutionRoleArn { get; set; }
Property Value
System.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.
public IBootstrapRole LookupRole { get; set; }
Property Value
Remarks
Default: - None
Parameters
Values for CloudFormation stack parameters that should be passed when the stack is deployed.
public IDictionary<string, string> Parameters { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Default: - No parameters
RequiresBootstrapStackVersion
Version of bootstrap stack required to deploy this stack.
public Nullable<double> RequiresBootstrapStackVersion { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: - No bootstrap stack required
StackTemplateAssetObjectUrl
If the stack template has already been included in the asset manifest, its asset URL.
public string StackTemplateAssetObjectUrl { get; set; }
Property Value
System.String
Remarks
Default: - Not uploaded yet, upload just before deploying