@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:42.898Z") @Stability(value=Stable) 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 and Type | Class and Description |
|---|---|
static class |
CloudFormationStackArtifact.Builder
A fluent builder for
CloudFormationStackArtifact. |
| Modifier | Constructor and Description |
|---|---|
|
CloudFormationStackArtifact(CloudAssembly assembly,
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 |
|---|---|
List<Object> |
getAssets()
Any assets associated with this stack.
|
String |
getAssumeRoleArn()
The role that needs to be assumed to deploy the stack.
|
String |
getAssumeRoleExternalId()
External ID to use when assuming role for cloudformation deployments.
|
String |
getBootstrapStackVersionSsmParameter()
Name of SSM parameter with bootstrap stack version.
|
String |
getCloudFormationExecutionRoleArn()
The role that is passed to CloudFormation to execute the change set.
|
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.
|
String |
getOriginalName()
The original name as defined in the CDK app.
|
Map<String,String> |
getParameters()
CloudFormation parameters to pass to the stack.
|
Number |
getRequiresBootstrapStackVersion()
Version of bootstrap stack required to deploy this stack.
|
String |
getStackName()
The physical name of this stack.
|
String |
getStackTemplateAssetObjectUrl()
If the stack template has already been included in the asset manifest, its asset URL.
|
Map<String,String> |
getTags()
CloudFormation tags to pass to the stack.
|
Object |
getTemplate()
The CloudFormation template for this stack.
|
String |
getTemplateFile()
The file name of the template.
|
String |
getTemplateFullPath()
Full path to the template file.
|
Boolean |
getTerminationProtection()
Whether termination protection is enabled for this stack.
|
Boolean |
getValidateOnSynth()
Whether this stack should be validated by the CLI after synthesis.
|
findMetadataByType, fromManifest, getAssembly, getDependencies, getHierarchicalId, getId, getManifest, getMessagesjsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetprotected CloudFormationStackArtifact(software.amazon.jsii.JsiiObjectRef objRef)
protected CloudFormationStackArtifact(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CloudFormationStackArtifact(@NotNull
CloudAssembly assembly,
@NotNull
String artifactId,
@NotNull
ArtifactManifest artifact)
assembly - This parameter is required.artifactId - This parameter is required.artifact - This parameter is required.@Stability(value=Stable) @NotNull public List<Object> getAssets()
@Stability(value=Stable) @NotNull public 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 "
@Stability(value=Stable) @NotNull public Environment getEnvironment()
@Stability(value=Stable) @NotNull public String getOriginalName()
@Stability(value=Stable) @NotNull public Map<String,String> getParameters()
@Stability(value=Stable) @NotNull public String getStackName()
@Stability(value=Stable) @NotNull public Map<String,String> getTags()
@Stability(value=Stable) @NotNull public Object getTemplate()
@Stability(value=Stable) @NotNull public String getTemplateFile()
@Stability(value=Stable) @NotNull public String getTemplateFullPath()
@Stability(value=Stable) @Nullable public String getAssumeRoleArn()
Default: - No role is assumed (current credentials are used)
@Stability(value=Stable) @Nullable public String getAssumeRoleExternalId()
Default: - No external ID
@Stability(value=Stable) @Nullable public String getBootstrapStackVersionSsmParameter()
Default: - Discover SSM parameter by reading stack
@Stability(value=Stable) @Nullable public String getCloudFormationExecutionRoleArn()
Default: - No role is passed (currently assumed role/credentials are used)
@Stability(value=Stable) @Nullable public BootstrapRole getLookupRole()
Default: - No role is assumed (current credentials are used)
@Stability(value=Stable) @Nullable public Number getRequiresBootstrapStackVersion()
Default: - No bootstrap stack required
@Stability(value=Stable) @Nullable public String getStackTemplateAssetObjectUrl()
Default: - Not uploaded yet, upload just before deploying
@Stability(value=Stable) @Nullable public Boolean getTerminationProtection()
@Stability(value=Stable) @Nullable public Boolean getValidateOnSynth()
Default: - false
Copyright © 2022. All rights reserved.