software.amazon.awscdk.pipelines.StackDeployment Maven / Gradle / Ivy
Show all versions of cdk-pipelines Show documentation
package software.amazon.awscdk.pipelines;
/**
* Deployment of a single Stack.
*
* You don't need to instantiate this class -- it will
* be automatically instantiated as necessary when you
* add a Stage to a pipeline.
*
* Example:
*
*
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import software.amazon.awscdk.cxapi.*;
* import software.amazon.awscdk.pipelines.*;
* CloudFormationStackArtifact cloudFormationStackArtifact;
* StackDeployment stackDeployment = StackDeployment.fromArtifact(cloudFormationStackArtifact);
*
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.84.0 (build 5404dcf)", date = "2023-06-19T16:30:49.890Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.pipelines.$Module.class, fqn = "@aws-cdk/pipelines.StackDeployment")
public class StackDeployment extends software.amazon.jsii.JsiiObject {
protected StackDeployment(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected StackDeployment(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
* Build a StackDeployment from a Stack Artifact in a Cloud Assembly.
*
* @param stackArtifact This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static @org.jetbrains.annotations.NotNull software.amazon.awscdk.pipelines.StackDeployment fromArtifact(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.cxapi.CloudFormationStackArtifact stackArtifact) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(software.amazon.awscdk.pipelines.StackDeployment.class, "fromArtifact", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.pipelines.StackDeployment.class), new Object[] { java.util.Objects.requireNonNull(stackArtifact, "stackArtifact is required") });
}
/**
* Add a dependency on another stack.
*
* @param stackDeployment This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void addStackDependency(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.pipelines.StackDeployment stackDeployment) {
software.amazon.jsii.Kernel.call(this, "addStackDependency", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(stackDeployment, "stackDeployment is required") });
}
/**
* Adds steps to each phase of the stack.
*
* @param pre steps executed before stack.prepare. This parameter is required.
* @param changeSet steps executed after stack.prepare and before stack.deploy. This parameter is required.
* @param post steps executed after stack.deploy. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void addStackSteps(final @org.jetbrains.annotations.NotNull java.util.List pre, final @org.jetbrains.annotations.NotNull java.util.List changeSet, final @org.jetbrains.annotations.NotNull java.util.List post) {
software.amazon.jsii.Kernel.call(this, "addStackSteps", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(pre, "pre is required"), java.util.Objects.requireNonNull(changeSet, "changeSet is required"), java.util.Objects.requireNonNull(post, "post is required") });
}
/**
* Template path on disk to CloudAssembly.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.lang.String getAbsoluteTemplatePath() {
return software.amazon.jsii.Kernel.get(this, "absoluteTemplatePath", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Assets referenced by this stack.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.util.List getAssets() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "assets", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.pipelines.StackAsset.class))));
}
/**
* Steps that take place after stack is prepared but before stack deploys.
*
* Your pipeline engine may not disable prepareStep.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.util.List getChangeSet() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "changeSet", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.pipelines.Step.class))));
}
/**
* Construct path for this stack.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.lang.String getConstructPath() {
return software.amazon.jsii.Kernel.get(this, "constructPath", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Steps to execute after stack deploys.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.util.List getPost() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "post", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.pipelines.Step.class))));
}
/**
* Steps that take place before stack is prepared.
*
* If your pipeline engine disables 'prepareStep', then this will happen before stack deploys
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.util.List getPre() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "pre", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.pipelines.Step.class))));
}
/**
* Artifact ID for this stack.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.lang.String getStackArtifactId() {
return software.amazon.jsii.Kernel.get(this, "stackArtifactId", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Other stacks this stack depends on.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.util.List getStackDependencies() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "stackDependencies", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.pipelines.StackDeployment.class))));
}
/**
* Name for this stack.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.lang.String getStackName() {
return software.amazon.jsii.Kernel.get(this, "stackName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Tags to apply to the stack.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.util.Map getTags() {
return java.util.Collections.unmodifiableMap(software.amazon.jsii.Kernel.get(this, "tags", software.amazon.jsii.NativeType.mapOf(software.amazon.jsii.NativeType.forClass(java.lang.String.class))));
}
/**
* Account where the stack should be deployed.
*
* Default: - Pipeline account
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.Nullable java.lang.String getAccount() {
return software.amazon.jsii.Kernel.get(this, "account", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Role to assume before deploying this stack.
*
* Default: - Don't assume any role
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.Nullable java.lang.String getAssumeRoleArn() {
return software.amazon.jsii.Kernel.get(this, "assumeRoleArn", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Execution role to pass to CloudFormation.
*
* Default: - No execution role
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.Nullable java.lang.String getExecutionRoleArn() {
return software.amazon.jsii.Kernel.get(this, "executionRoleArn", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Region where the stack should be deployed.
*
* Default: - Pipeline region
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.Nullable java.lang.String getRegion() {
return software.amazon.jsii.Kernel.get(this, "region", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* The asset that represents the CloudFormation template for this stack.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.Nullable software.amazon.awscdk.pipelines.StackAsset getTemplateAsset() {
return software.amazon.jsii.Kernel.get(this, "templateAsset", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.pipelines.StackAsset.class));
}
/**
* The S3 URL which points to the template asset location in the publishing bucket.
*
* This is undefined if the stack template is not published. Use the
* DefaultStackSynthesizer to ensure it is.
*
* Example value: https://bucket.s3.amazonaws.com/object/key
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.Nullable java.lang.String getTemplateUrl() {
return software.amazon.jsii.Kernel.get(this, "templateUrl", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
}