Class CloudFormationStackArtifact
- All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.cloud_assembly_schema.*; import software.amazon.awscdk.cxapi.*; Object assumeRoleAdditionalOptions; 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 .assumeRoleAdditionalOptions(Map.of( "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions)) .assumeRoleArn("assumeRoleArn") .assumeRoleExternalId("assumeRoleExternalId") .bootstrapStackVersionSsmParameter("bootstrapStackVersionSsmParameter") .cloudFormationExecutionRoleArn("cloudFormationExecutionRoleArn") .lookupRole(BootstrapRole.builder() .arn("arn") // the properties below are optional .assumeRoleAdditionalOptions(Map.of( "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions)) .assumeRoleExternalId("assumeRoleExternalId") .bootstrapStackVersionSsmParameter("bootstrapStackVersionSsmParameter") .requiresBootstrapStackVersion(123) .build()) .notificationArns(List.of("notificationArns")) .parameters(Map.of( "parametersKey", "parameters")) .requiresBootstrapStackVersion(123) .stackName("stackName") .stackTemplateAssetObjectUrl("stackTemplateAssetObjectUrl") .tags(Map.of( "tagsKey", "tags")) .terminationProtection(false) .validateOnSynth(false) .build()) .build();
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCloudFormationStackArtifact
.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
-
Constructor Summary
ModifierConstructorDescriptionCloudFormationStackArtifact
(CloudAssembly assembly, String artifactId, ArtifactManifest artifact) protected
CloudFormationStackArtifact
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CloudFormationStackArtifact
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionAny assets associated with this stack.Additional options to pass to STS when assuming the role for cloudformation deployments.The role that needs to be assumed to deploy the stack.External ID to use when assuming role for cloudformation deployments.Name of SSM parameter with bootstrap stack version.The role that is passed to CloudFormation to execute the change set.A string that represents this stack.The environment into which to deploy this artifact.The role to use to look up values from the target AWS account.SNS Topics that will receive stack events.The original name as defined in the CDK app.CloudFormation parameters to pass to the stack.Version of bootstrap stack required to deploy this stack.The physical name of this stack.If the stack template has already been included in the asset manifest, its asset URL.getTags()
CloudFormation tags to pass to the stack.The CloudFormation template for this stack.The file name of the template.Full path to the template file.Whether termination protection is enabled for this stack.Whether this stack should be validated by the CLI after synthesis.static Boolean
Checks ifart
is an instance of this class.Methods inherited from class software.amazon.awscdk.cxapi.CloudArtifact
findMetadataByType, fromManifest, getAssembly, getDependencies, getHierarchicalId, getId, getManifest, getMessages
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
CloudFormationStackArtifact
protected CloudFormationStackArtifact(software.amazon.jsii.JsiiObjectRef objRef) -
CloudFormationStackArtifact
protected CloudFormationStackArtifact(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CloudFormationStackArtifact
@Stability(Stable) public CloudFormationStackArtifact(@NotNull CloudAssembly assembly, @NotNull String artifactId, @NotNull ArtifactManifest artifact) - Parameters:
assembly
- This parameter is required.artifactId
- This parameter is required.artifact
- This parameter is required.
-
-
Method Details
-
isCloudFormationStackArtifact
@Stability(Stable) @NotNull public static Boolean isCloudFormationStackArtifact(@NotNull Object art) Checks ifart
is an instance of this class.Use this method instead of
instanceof
to properly detectCloudFormationStackArtifact
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
cx-api
library on disk are seen as independent, completely different libraries. As a consequence, the classCloudFormationStackArtifact
in each copy of thecx-api
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of thecx-api
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
art
- This parameter is required.
-
getAssets
Any assets associated with this stack. -
getDisplayName
A string that represents this stack.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 "
( )" -
getEnvironment
The environment into which to deploy this artifact. -
getNotificationArns
SNS Topics that will receive stack events. -
getOriginalName
The original name as defined in the CDK app. -
getParameters
CloudFormation parameters to pass to the stack. -
getStackName
The physical name of this stack. -
getTags
CloudFormation tags to pass to the stack. -
getTemplate
The CloudFormation template for this stack. -
getTemplateFile
The file name of the template. -
getTemplateFullPath
Full path to the template file. -
getAssumeRoleAdditionalOptions
Additional options to pass to STS when assuming the role for cloudformation deployments.RoleArn
should not be used. Use the dedicatedassumeRoleArn
property instead.ExternalId
should not be used. Use the dedicatedassumeRoleExternalId
instead.TransitiveTagKeys
defaults to use all keys (if any) specified inTags
. E.g, all tags are transitive by default.
Default: - No additional options.
- See Also:
-
getAssumeRoleArn
The role that needs to be assumed to deploy the stack.Default: - No role is assumed (current credentials are used)
-
getAssumeRoleExternalId
External ID to use when assuming role for cloudformation deployments.Default: - No external ID
-
getBootstrapStackVersionSsmParameter
Name of SSM parameter with bootstrap stack version.Default: - Discover SSM parameter by reading stack
-
getCloudFormationExecutionRoleArn
The role that is passed to CloudFormation to execute the change set.Default: - No role is passed (currently assumed role/credentials are used)
-
getLookupRole
The role to use to look up values from the target AWS account.Default: - No role is assumed (current credentials are used)
-
getRequiresBootstrapStackVersion
Version of bootstrap stack required to deploy this stack.Default: - No bootstrap stack required
-
getStackTemplateAssetObjectUrl
If the stack template has already been included in the asset manifest, its asset URL.Default: - Not uploaded yet, upload just before deploying
-
getTerminationProtection
Whether termination protection is enabled for this stack. -
getValidateOnSynth
Whether this stack should be validated by the CLI after synthesis.Default: - false
-