software.amazon.awscdk.services.codepipeline.actions

Class CloudFormationExecuteChangeSetActionProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.codepipeline.actions.CloudFormationExecuteChangeSetActionProps.Jsii$Proxy

All Implemented Interfaces:

CloudFormationExecuteChangeSetActionProps, CommonActionProps, CommonAwsActionProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CloudFormationExecuteChangeSetActionProps

@Stability(value=Experimental)
 @Internal
public static final class CloudFormationExecuteChangeSetActionProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CloudFormationExecuteChangeSetActionProps

An implementation for CloudFormationExecuteChangeSetActionProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.codepipeline.actions.CloudFormationExecuteChangeSetActionProps

CloudFormationExecuteChangeSetActionProps.Builder, CloudFormationExecuteChangeSetActionProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.
protected	Jsii$Proxy(String changeSetName, String stackName, String account, Artifact output, String outputFileName, String region, IRole role, String actionName, Number runOrder, String variablesNamespace) Constructor that initializes the object based on literal property values passed by the CloudFormationExecuteChangeSetActionProps.Builder.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
String	getAccount() (experimental) The AWS account this Action is supposed to operate in.
String	getActionName() (experimental) The physical, human-readable name of the Action.
String	getChangeSetName() (experimental) Name of the change set to execute.
Artifact	getOutput() (experimental) The name of the output artifact to generate.
String	getOutputFileName() (experimental) A name for the filename in the output artifact to store the AWS CloudFormation call's result.
String	getRegion() (experimental) The AWS region the given Action resides in.
IRole	getRole() (experimental) The Role in which context's this Action will be executing in.
Number	getRunOrder() (experimental) The runOrder property for this Action.
String	getStackName() (experimental) The name of the stack to apply this action to.
String	getVariablesNamespace() (experimental) The name of the namespace to use for variables emitted by this action.
int	hashCode()

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.services.codepipeline.actions.CloudFormationExecuteChangeSetActionProps

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(String changeSetName,
                     String stackName,
                     String account,
                     Artifact output,
                     String outputFileName,
                     String region,
                     IRole role,
                     String actionName,
                     Number runOrder,
                     String variablesNamespace)

Constructor that initializes the object based on literal property values passed by the CloudFormationExecuteChangeSetActionProps.Builder.

Method Detail

getChangeSetName

public final String getChangeSetName()

Description copied from interface: CloudFormationExecuteChangeSetActionProps

(experimental) Name of the change set to execute.

Specified by:

getChangeSetName in interface CloudFormationExecuteChangeSetActionProps

getStackName

public final String getStackName()

Description copied from interface: CloudFormationExecuteChangeSetActionProps

(experimental) The name of the stack to apply this action to.

Specified by:

getStackName in interface CloudFormationExecuteChangeSetActionProps

getAccount

public final String getAccount()

Description copied from interface: CloudFormationExecuteChangeSetActionProps

(experimental) The AWS account this Action is supposed to operate in.

Note: if you specify the role property, this is ignored - the action will operate in the same region the passed role does.

Default: - action resides in the same account as the pipeline

Specified by:

getAccount in interface CloudFormationExecuteChangeSetActionProps

getOutput

public final Artifact getOutput()

Description copied from interface: CloudFormationExecuteChangeSetActionProps

(experimental) The name of the output artifact to generate.

Only applied if outputFileName is set as well.

Default: Automatically generated artifact name.

Specified by:

getOutput in interface CloudFormationExecuteChangeSetActionProps

getOutputFileName

public final String getOutputFileName()

Description copied from interface: CloudFormationExecuteChangeSetActionProps

(experimental) 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

Specified by:

getOutputFileName in interface CloudFormationExecuteChangeSetActionProps

getRegion

public final String getRegion()

Description copied from interface: CloudFormationExecuteChangeSetActionProps

(experimental) The AWS region the given Action resides in.

Note that a cross-region Pipeline requires replication buckets to function correctly. You can provide their names with the {@link PipelineProps#crossRegionReplicationBuckets} property. If you don't, the CodePipeline Construct will create new Stacks in your CDK app containing those buckets, that you will need to cdk deploy before deploying the main, Pipeline-containing Stack.

Default: the Action resides in the same region as the Pipeline

Specified by:

getRegion in interface CloudFormationExecuteChangeSetActionProps

getRole

public final IRole getRole()

Description copied from interface: CommonAwsActionProps

(experimental) The Role in which context's this Action will be executing in.

The Pipeline's Role will assume this Role (the required permissions for that will be granted automatically) right before executing this Action. This Action will be passed into your {@link IAction.bind} method in the {@link ActionBindOptions.role} property.

Default: a new Role will be generated

Specified by:

getRole in interface CommonAwsActionProps

getActionName

public final String getActionName()

Description copied from interface: CommonActionProps

(experimental) The physical, human-readable name of the Action.

Note that Action names must be unique within a single Stage.

Specified by:

getActionName in interface CommonActionProps

getRunOrder

public final Number getRunOrder()

Description copied from interface: CommonActionProps

(experimental) The runOrder property for this Action.

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

Default: 1

Specified by:

getRunOrder in interface CommonActionProps

See Also:

https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html

getVariablesNamespace

public final String getVariablesNamespace()

Description copied from interface: CommonActionProps

(experimental) The name of the namespace to use for variables emitted by this action.

Default: - a name will be generated, based on the stage and action names, if any of the action's variables were referenced - otherwise, no namespace will be set

Specified by:

getVariablesNamespace in interface CommonActionProps

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object