@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)", date="2022-05-20T22:19:52.830Z") public class CloudFormationStackArtifact extends CloudArtifact
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.cloudassembly.schema.*; import software.amazon.awscdk.cxapi.*; CloudAssembly cloudAssembly; CloudFormationStackArtifact cloudFormationStackArtifact = CloudFormationStackArtifact.Builder.create(cloudAssembly, "artifactId") .type(ArtifactType.NONE) // the properties below are optional .dependencies(List.of("dependencies")) .displayName("displayName") .environment("environment") .metadata(Map.of( "metadataKey", List.of(MetadataEntry.builder() .type("type") // the properties below are optional .data("data") .trace(List.of("trace")) .build()))) .properties(AwsCloudFormationStackProperties.builder() .templateFile("templateFile") // the properties below are optional .assumeRoleArn("assumeRoleArn") .assumeRoleExternalId("assumeRoleExternalId") .bootstrapStackVersionSsmParameter("bootstrapStackVersionSsmParameter") .cloudFormationExecutionRoleArn("cloudFormationExecutionRoleArn") .lookupRole(BootstrapRole.builder() .arn("arn") // the properties below are optional .assumeRoleExternalId("assumeRoleExternalId") .bootstrapStackVersionSsmParameter("bootstrapStackVersionSsmParameter") .requiresBootstrapStackVersion(123) .build()) .parameters(Map.of( "parametersKey", "parameters")) .requiresBootstrapStackVersion(123) .stackName("stackName") .stackTemplateAssetObjectUrl("stackTemplateAssetObjectUrl") .tags(Map.of( "tagsKey", "tags")) .terminationProtection(false) .validateOnSynth(false) .build()) .build();
Modifier | Constructor and Description |
---|---|
|
CloudFormationStackArtifact(CloudAssembly assembly,
java.lang.String artifactId,
ArtifactManifest artifact) |
protected |
CloudFormationStackArtifact(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CloudFormationStackArtifact(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.util.List<java.lang.Object> |
getAssets()
Any assets associated with this stack.
|
java.lang.String |
getAssumeRoleArn()
The role that needs to be assumed to deploy the stack.
|
java.lang.String |
getAssumeRoleExternalId()
External ID to use when assuming role for cloudformation deployments.
|
java.lang.String |
getBootstrapStackVersionSsmParameter()
Name of SSM parameter with bootstrap stack version.
|
java.lang.String |
getCloudFormationExecutionRoleArn()
The role that is passed to CloudFormation to execute the change set.
|
java.lang.String |
getDisplayName()
A string that represents this stack.
|
Environment |
getEnvironment()
The environment into which to deploy this artifact.
|
BootstrapRole |
getLookupRole()
The role to use to look up values from the target AWS account.
|
java.lang.String |
getName()
Deprecated.
renamed to `stackName`
|
java.lang.String |
getOriginalName()
The original name as defined in the CDK app.
|
java.util.Map<java.lang.String,java.lang.String> |
getParameters()
CloudFormation parameters to pass to the stack.
|
java.lang.Number |
getRequiresBootstrapStackVersion()
Version of bootstrap stack required to deploy this stack.
|
java.lang.String |
getStackName()
The physical name of this stack.
|
java.lang.String |
getStackTemplateAssetObjectUrl()
If the stack template has already been included in the asset manifest, its asset URL.
|
java.util.Map<java.lang.String,java.lang.String> |
getTags()
CloudFormation tags to pass to the stack.
|
java.lang.Object |
getTemplate()
The CloudFormation template for this stack.
|
java.lang.String |
getTemplateFile()
The file name of the template.
|
java.lang.String |
getTemplateFullPath()
Full path to the template file.
|
java.lang.Boolean |
getTerminationProtection()
Whether termination protection is enabled for this stack.
|
java.lang.Boolean |
getValidateOnSynth()
Whether this stack should be validated by the CLI after synthesis.
|
findMetadataByType, fromManifest, getAssembly, getDependencies, getHierarchicalId, getId, getManifest, getMessages
protected CloudFormationStackArtifact(software.amazon.jsii.JsiiObjectRef objRef)
protected CloudFormationStackArtifact(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CloudFormationStackArtifact(CloudAssembly assembly, java.lang.String artifactId, ArtifactManifest artifact)
assembly
- This parameter is required.artifactId
- This parameter is required.artifact
- This parameter is required.public java.util.List<java.lang.Object> getAssets()
public java.lang.String getDisplayName()
Should only be used in user
interfaces. If the stackName has not been set explicitly, or has been set
to artifactId, it will return the hierarchicalId of the stack. Otherwise,
it will return something like "
public Environment getEnvironment()
@Deprecated public java.lang.String getName()
public java.lang.String getOriginalName()
public java.util.Map<java.lang.String,java.lang.String> getParameters()
public java.lang.String getStackName()
public java.util.Map<java.lang.String,java.lang.String> getTags()
public java.lang.Object getTemplate()
public java.lang.String getTemplateFile()
public java.lang.String getTemplateFullPath()
public java.lang.String getAssumeRoleArn()
Default: - No role is assumed (current credentials are used)
public java.lang.String getAssumeRoleExternalId()
Default: - No external ID
public java.lang.String getBootstrapStackVersionSsmParameter()
Default: - Discover SSM parameter by reading stack
public java.lang.String getCloudFormationExecutionRoleArn()
Default: - No role is passed (currently assumed role/credentials are used)
public BootstrapRole getLookupRole()
Default: - No role is assumed (current credentials are used)
public java.lang.Number getRequiresBootstrapStackVersion()
Default: - No bootstrap stack required
public java.lang.String getStackTemplateAssetObjectUrl()
Default: - Not uploaded yet, upload just before deploying
public java.lang.Boolean getTerminationProtection()
public java.lang.Boolean getValidateOnSynth()
Default: - false