software.amazon.awscdk.services.cloudformation.PipelineExecuteChangeSetActionProps Maven / Gradle / Ivy
package software.amazon.awscdk.services.cloudformation;
/**
* Properties for the PipelineExecuteChangeSetAction.
*/
@javax.annotation.Generated(value = "jsii-pacmak/0.7.8 (build 100f5ad)", date = "2018-11-06T17:22:28.227Z")
public interface PipelineExecuteChangeSetActionProps extends software.amazon.jsii.JsiiSerializable, software.amazon.awscdk.services.cloudformation.PipelineCloudFormationActionProps {
/**
* Name of the change set to execute.
*/
java.lang.String getChangeSetName();
/**
* Name of the change set to execute.
*/
void setChangeSetName(final java.lang.String value);
/**
* @return a {@link Builder} of {@link PipelineExecuteChangeSetActionProps}
*/
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link PipelineExecuteChangeSetActionProps}
*/
final class Builder {
private java.lang.String _changeSetName;
private java.lang.String _stackName;
@javax.annotation.Nullable
private java.lang.String _outputArtifactName;
@javax.annotation.Nullable
private java.lang.String _outputFileName;
@javax.annotation.Nullable
private java.lang.Number _runOrder;
private software.amazon.awscdk.services.codepipeline.api.IStage _stage;
/**
* Sets the value of ChangeSetName
* @param value Name of the change set to execute.
* @return {@code this}
*/
public Builder withChangeSetName(final java.lang.String value) {
this._changeSetName = java.util.Objects.requireNonNull(value, "changeSetName is required");
return this;
}
/**
* Sets the value of StackName
* @param value The name of the stack to apply this action to
* @return {@code this}
*/
public Builder withStackName(final java.lang.String value) {
this._stackName = java.util.Objects.requireNonNull(value, "stackName is required");
return this;
}
/**
* Sets the value of OutputArtifactName
* @param value The name of the output artifact to generate
Only applied if `outputFileName` is set as well.
* @return {@code this}
*/
public Builder withOutputArtifactName(@javax.annotation.Nullable final java.lang.String value) {
this._outputArtifactName = value;
return this;
}
/**
* Sets the value of OutputFileName
* @param value A name for the filename in the output artifact to store the AWS CloudFormation call's result.
The file will contain the result of the call to AWS CloudFormation (for example
the call to UpdateStack or CreateChangeSet).
AWS CodePipeline adds the file to the output artifact after performing
the specified action.
* @return {@code this}
*/
public Builder withOutputFileName(@javax.annotation.Nullable final java.lang.String value) {
this._outputFileName = value;
return this;
}
/**
* Sets the value of RunOrder
* @param value The runOrder property for this Action.
RunOrder determines the relative order in which multiple Actions in the same Stage execute.
* @return {@code this}
*/
public Builder withRunOrder(@javax.annotation.Nullable final java.lang.Number value) {
this._runOrder = value;
return this;
}
/**
* Sets the value of Stage
* @param value The Pipeline Stage to add this Action to.
* @return {@code this}
*/
public Builder withStage(final software.amazon.awscdk.services.codepipeline.api.IStage value) {
this._stage = java.util.Objects.requireNonNull(value, "stage is required");
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link PipelineExecuteChangeSetActionProps}
* @throws NullPointerException if any required attribute was not provided
*/
public PipelineExecuteChangeSetActionProps build() {
return new PipelineExecuteChangeSetActionProps() {
private java.lang.String $changeSetName = java.util.Objects.requireNonNull(_changeSetName, "changeSetName is required");
private java.lang.String $stackName = java.util.Objects.requireNonNull(_stackName, "stackName is required");
@javax.annotation.Nullable
private java.lang.String $outputArtifactName = _outputArtifactName;
@javax.annotation.Nullable
private java.lang.String $outputFileName = _outputFileName;
@javax.annotation.Nullable
private java.lang.Number $runOrder = _runOrder;
private software.amazon.awscdk.services.codepipeline.api.IStage $stage = java.util.Objects.requireNonNull(_stage, "stage is required");
@Override
public java.lang.String getChangeSetName() {
return this.$changeSetName;
}
@Override
public void setChangeSetName(final java.lang.String value) {
this.$changeSetName = java.util.Objects.requireNonNull(value, "changeSetName is required");
}
@Override
public java.lang.String getStackName() {
return this.$stackName;
}
@Override
public void setStackName(final java.lang.String value) {
this.$stackName = java.util.Objects.requireNonNull(value, "stackName is required");
}
@Override
public java.lang.String getOutputArtifactName() {
return this.$outputArtifactName;
}
@Override
public void setOutputArtifactName(@javax.annotation.Nullable final java.lang.String value) {
this.$outputArtifactName = value;
}
@Override
public java.lang.String getOutputFileName() {
return this.$outputFileName;
}
@Override
public void setOutputFileName(@javax.annotation.Nullable final java.lang.String value) {
this.$outputFileName = value;
}
@Override
public java.lang.Number getRunOrder() {
return this.$runOrder;
}
@Override
public void setRunOrder(@javax.annotation.Nullable final java.lang.Number value) {
this.$runOrder = value;
}
@Override
public software.amazon.awscdk.services.codepipeline.api.IStage getStage() {
return this.$stage;
}
@Override
public void setStage(final software.amazon.awscdk.services.codepipeline.api.IStage value) {
this.$stage = java.util.Objects.requireNonNull(value, "stage is required");
}
};
}
}
/**
* A proxy class which represents a concrete javascript instance of this type.
*/
final static class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements software.amazon.awscdk.services.cloudformation.PipelineExecuteChangeSetActionProps {
protected Jsii$Proxy(final software.amazon.jsii.JsiiObject.InitializationMode mode) {
super(mode);
}
/**
* Name of the change set to execute.
*/
@Override
public java.lang.String getChangeSetName() {
return this.jsiiGet("changeSetName", java.lang.String.class);
}
/**
* Name of the change set to execute.
*/
@Override
public void setChangeSetName(final java.lang.String value) {
this.jsiiSet("changeSetName", java.util.Objects.requireNonNull(value, "changeSetName is required"));
}
/**
* The name of the stack to apply this action to
*/
@Override
public java.lang.String getStackName() {
return this.jsiiGet("stackName", java.lang.String.class);
}
/**
* The name of the stack to apply this action to
*/
@Override
public void setStackName(final java.lang.String value) {
this.jsiiSet("stackName", java.util.Objects.requireNonNull(value, "stackName is required"));
}
/**
* The name of the output artifact to generate
*
* Only applied if `outputFileName` is set as well.
* @default Automatically generated artifact name.
*/
@Override
@javax.annotation.Nullable
public java.lang.String getOutputArtifactName() {
return this.jsiiGet("outputArtifactName", java.lang.String.class);
}
/**
* The name of the output artifact to generate
*
* Only applied if `outputFileName` is set as well.
* @default Automatically generated artifact name.
*/
@Override
public void setOutputArtifactName(@javax.annotation.Nullable final java.lang.String value) {
this.jsiiSet("outputArtifactName", value);
}
/**
* A name for the filename in the output artifact to store the AWS CloudFormation call's result.
*
* The file will contain the result of the call to AWS CloudFormation (for example
* the call to UpdateStack or CreateChangeSet).
*
* AWS CodePipeline adds the file to the output artifact after performing
* the specified action.
* @default No output artifact generated
*/
@Override
@javax.annotation.Nullable
public java.lang.String getOutputFileName() {
return this.jsiiGet("outputFileName", java.lang.String.class);
}
/**
* A name for the filename in the output artifact to store the AWS CloudFormation call's result.
*
* The file will contain the result of the call to AWS CloudFormation (for example
* the call to UpdateStack or CreateChangeSet).
*
* AWS CodePipeline adds the file to the output artifact after performing
* the specified action.
* @default No output artifact generated
*/
@Override
public void setOutputFileName(@javax.annotation.Nullable final java.lang.String value) {
this.jsiiSet("outputFileName", value);
}
/**
* The runOrder property for this Action.
* RunOrder determines the relative order in which multiple Actions in the same Stage execute.
* @default 1
* @see https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html
*/
@Override
@javax.annotation.Nullable
public java.lang.Number getRunOrder() {
return this.jsiiGet("runOrder", java.lang.Number.class);
}
/**
* The runOrder property for this Action.
* RunOrder determines the relative order in which multiple Actions in the same Stage execute.
* @default 1
* @see https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html
*/
@Override
public void setRunOrder(@javax.annotation.Nullable final java.lang.Number value) {
this.jsiiSet("runOrder", value);
}
/**
* The Pipeline Stage to add this Action to.
*/
@Override
public software.amazon.awscdk.services.codepipeline.api.IStage getStage() {
return this.jsiiGet("stage", software.amazon.awscdk.services.codepipeline.api.IStage.class);
}
/**
* The Pipeline Stage to add this Action to.
*/
@Override
public void setStage(final software.amazon.awscdk.services.codepipeline.api.IStage value) {
this.jsiiSet("stage", java.util.Objects.requireNonNull(value, "stage is required"));
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy