@Stability(value=Stable) @Internal public static final class CloudFormationCreateReplaceChangeSetActionProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CloudFormationCreateReplaceChangeSetActionProps
CloudFormationCreateReplaceChangeSetActionPropssoftware.amazon.jsii.JsiiObject.InitializationModeCloudFormationCreateReplaceChangeSetActionProps.Builder, CloudFormationCreateReplaceChangeSetActionProps.Jsii$Proxy| Modifier | Constructor and Description |
|---|---|
protected |
Jsii$Proxy(CloudFormationCreateReplaceChangeSetActionProps.Builder builder)
Constructor that initializes the object based on literal property values passed by the
CloudFormationCreateReplaceChangeSetActionProps.Builder. |
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
| Modifier and Type | Method and Description |
|---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(Object o) |
String |
getAccount()
The AWS account this Action is supposed to operate in.
|
String |
getActionName()
The physical, human-readable name of the Action.
|
Boolean |
getAdminPermissions()
Whether to grant full permissions to CloudFormation while deploying this template.
|
List<CfnCapabilities> |
getCfnCapabilities()
Acknowledge certain changes made as part of deployment.
|
String |
getChangeSetName()
Name of the change set to create or update.
|
IRole |
getDeploymentRole()
IAM role to assume when deploying changes.
|
List<Artifact> |
getExtraInputs()
The list of additional input Artifacts for this Action.
|
Artifact |
getOutput()
The name of the output artifact to generate.
|
String |
getOutputFileName()
A name for the filename in the output artifact to store the AWS CloudFormation call's result.
|
Map<String,Object> |
getParameterOverrides()
Additional template parameters.
|
String |
getRegion()
The AWS region the given Action resides in.
|
IRole |
getRole()
The Role in which context's this Action will be executing in.
|
Number |
getRunOrder()
The runOrder property for this Action.
|
String |
getStackName()
The name of the stack to apply this action to.
|
ArtifactPath |
getTemplateConfiguration()
Input artifact to use for template parameters values and stack policy.
|
ArtifactPath |
getTemplatePath()
Input artifact with the ChangeSet's CloudFormation template.
|
String |
getVariablesNamespace()
The name of the namespace to use for variables emitted by this action.
|
int |
hashCode() |
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitbuilderprotected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef - Reference to the JSII managed object.protected Jsii$Proxy(CloudFormationCreateReplaceChangeSetActionProps.Builder builder)
CloudFormationCreateReplaceChangeSetActionProps.Builder.public final Boolean getAdminPermissions()
CloudFormationCreateReplaceChangeSetActionProps
Setting this to true affects the defaults for role and capabilities, if you
don't specify any alternatives.
The default role that will be created for you will have full (i.e., *)
permissions on all resources, and the deployment will have named IAM
capabilities (i.e., able to create all IAM resources).
This is a shorthand that you can use if you fully trust the templates that
are deployed in this pipeline. If you want more fine-grained permissions,
use addToRolePolicy and capabilities to control what the CloudFormation
deployment is allowed to do.
getAdminPermissions in interface CloudFormationCreateReplaceChangeSetActionPropspublic final String getChangeSetName()
CloudFormationCreateReplaceChangeSetActionPropsgetChangeSetName in interface CloudFormationCreateReplaceChangeSetActionPropspublic final String getStackName()
CloudFormationCreateReplaceChangeSetActionPropsgetStackName in interface CloudFormationCreateReplaceChangeSetActionPropspublic final ArtifactPath getTemplatePath()
CloudFormationCreateReplaceChangeSetActionPropsgetTemplatePath in interface CloudFormationCreateReplaceChangeSetActionPropspublic final String getAccount()
CloudFormationCreateReplaceChangeSetActionProps
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
getAccount in interface CloudFormationCreateReplaceChangeSetActionPropspublic final List<CfnCapabilities> getCfnCapabilities()
CloudFormationCreateReplaceChangeSetActionProps
For stacks that contain certain resources,
explicit acknowledgement is required that AWS CloudFormation might create or update those resources.
For example, you must specify ANONYMOUS_IAM or NAMED_IAM if your stack template contains AWS
Identity and Access Management (IAM) resources.
For more information, see the link below.
Default: None, unless `adminPermissions` is true
public final IRole getDeploymentRole()
CloudFormationCreateReplaceChangeSetActionProps
If not specified, a fresh role is created. The role is created with zero
permissions unless adminPermissions is true, in which case the role will have
full permissions.
Default: A fresh role with full or no permissions (depending on the value of `adminPermissions`).
getDeploymentRole in interface CloudFormationCreateReplaceChangeSetActionPropspublic final List<Artifact> getExtraInputs()
CloudFormationCreateReplaceChangeSetActionProps
This is especially useful when used in conjunction with the parameterOverrides property.
For example, if you have:
parameterOverrides: { 'Param1': action1.outputArtifact.bucketName, 'Param2': action2.outputArtifact.objectKey, }
, if the output Artifacts of action1 and action2 were not used to
set either the templateConfiguration or the templatePath properties,
you need to make sure to include them in the extraInputs -
otherwise, you'll get an "unrecognized Artifact" error during your Pipeline's execution.
getExtraInputs in interface CloudFormationCreateReplaceChangeSetActionPropspublic final Artifact getOutput()
CloudFormationCreateReplaceChangeSetActionProps
Only applied if outputFileName is set as well.
Default: Automatically generated artifact name.
getOutput in interface CloudFormationCreateReplaceChangeSetActionPropspublic final String getOutputFileName()
CloudFormationCreateReplaceChangeSetActionPropsThe 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
getOutputFileName in interface CloudFormationCreateReplaceChangeSetActionPropspublic final Map<String,Object> getParameterOverrides()
CloudFormationCreateReplaceChangeSetActionProps
Template parameters specified here take precedence over template parameters
found in the artifact specified by the templateConfiguration property.
We recommend that you use the template configuration file to specify most of your parameter values. Use parameter overrides to specify only dynamic parameter values (values that are unknown until you run the pipeline).
All parameter names must be present in the stack template.
Note: the entire object cannot be more than 1kB.
Default: No overrides
getParameterOverrides in interface CloudFormationCreateReplaceChangeSetActionPropspublic final String getRegion()
CloudFormationCreateReplaceChangeSetActionProps
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
getRegion in interface CloudFormationCreateReplaceChangeSetActionPropspublic final ArtifactPath getTemplateConfiguration()
CloudFormationCreateReplaceChangeSetActionProps
The template configuration file should contain a JSON object that should look like this:
{ "Parameters": {...}, "Tags": {...}, "StackPolicy": {... }}. For more information,
see AWS CloudFormation Artifacts.
Note that if you include sensitive information, such as passwords, restrict access to this file.
Default: No template configuration based on input artifacts
getTemplateConfiguration in interface CloudFormationCreateReplaceChangeSetActionPropspublic final IRole getRole()
CommonAwsActionPropsThe 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
getRole in interface CommonAwsActionPropspublic final String getActionName()
CommonActionPropsNote that Action names must be unique within a single Stage.
getActionName in interface CommonActionPropspublic final Number getRunOrder()
CommonActionPropsRunOrder determines the relative order in which multiple Actions in the same Stage execute.
Default: 1
getRunOrder in interface CommonActionPropspublic final String getVariablesNamespace()
CommonActionPropsDefault: - 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
getVariablesNamespace in interface CommonActionProps@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
$jsii$toJson in interface software.amazon.jsii.JsiiSerializableCopyright © 2022. All rights reserved.