@Stability(value=Experimental) public static final class CloudFormationCreateUpdateStackActionProps.Builder extends Object implements software.amazon.jsii.Builder<CloudFormationCreateUpdateStackActionProps>
CloudFormationCreateUpdateStackActionProps| Constructor and Description |
|---|
Builder() |
@Stability(value=Experimental) public CloudFormationCreateUpdateStackActionProps.Builder adminPermissions(Boolean adminPermissions)
CloudFormationCreateUpdateStackActionProps.getAdminPermissions()adminPermissions - Whether to grant full permissions to CloudFormation while deploying this template. This parameter is required.
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.
this@Stability(value=Experimental) public CloudFormationCreateUpdateStackActionProps.Builder stackName(String stackName)
CloudFormationCreateUpdateStackActionProps.getStackName()stackName - The name of the stack to apply this action to. This parameter is required.this@Stability(value=Experimental) public CloudFormationCreateUpdateStackActionProps.Builder templatePath(ArtifactPath templatePath)
CloudFormationCreateUpdateStackActionProps.getTemplatePath()templatePath - Input artifact with the CloudFormation template to deploy. This parameter is required.this@Stability(value=Experimental) public CloudFormationCreateUpdateStackActionProps.Builder account(String account)
CloudFormationCreateUpdateStackActionProps.getAccount()account - 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.this@Stability(value=Experimental) public CloudFormationCreateUpdateStackActionProps.Builder cfnCapabilities(List<? extends CfnCapabilities> cfnCapabilities)
CloudFormationCreateUpdateStackActionProps.getCfnCapabilities()cfnCapabilities - Acknowledge certain changes made as part of deployment.
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.this@Stability(value=Experimental) public CloudFormationCreateUpdateStackActionProps.Builder deploymentRole(IRole deploymentRole)
CloudFormationCreateUpdateStackActionProps.getDeploymentRole()deploymentRole - IAM role to assume when deploying changes.
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.this@Stability(value=Experimental) public CloudFormationCreateUpdateStackActionProps.Builder extraInputs(List<? extends Artifact> extraInputs)
CloudFormationCreateUpdateStackActionProps.getExtraInputs()extraInputs - The list of additional input Artifacts for this Action.
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.
this@Stability(value=Experimental) public CloudFormationCreateUpdateStackActionProps.Builder output(Artifact output)
CloudFormationCreateUpdateStackActionProps.getOutput()output - The name of the output artifact to generate.
Only applied if outputFileName is set as well.this@Stability(value=Experimental) public CloudFormationCreateUpdateStackActionProps.Builder outputFileName(String outputFileName)
CloudFormationCreateUpdateStackActionProps.getOutputFileName()outputFileName - 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.
this@Stability(value=Experimental) public CloudFormationCreateUpdateStackActionProps.Builder parameterOverrides(Map<String,? extends Object> parameterOverrides)
CloudFormationCreateUpdateStackActionProps.getParameterOverrides()parameterOverrides - Additional template parameters.
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.
this@Stability(value=Experimental) public CloudFormationCreateUpdateStackActionProps.Builder region(String region)
CloudFormationCreateUpdateStackActionProps.getRegion()region - 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.this@Stability(value=Experimental) public CloudFormationCreateUpdateStackActionProps.Builder replaceOnFailure(Boolean replaceOnFailure)
CloudFormationCreateUpdateStackActionProps.getReplaceOnFailure()replaceOnFailure - Replace the stack if it's in a failed state.
If this is set to true and the stack is in a failed state (one of
ROLLBACK_COMPLETE, ROLLBACK_FAILED, CREATE_FAILED, DELETE_FAILED, or
UPDATE_ROLLBACK_FAILED), AWS CloudFormation deletes the stack and then
creates a new stack.
If this is not set to true and the stack is in a failed state, the deployment fails.
this@Stability(value=Experimental) public CloudFormationCreateUpdateStackActionProps.Builder templateConfiguration(ArtifactPath templateConfiguration)
CloudFormationCreateUpdateStackActionProps.getTemplateConfiguration()templateConfiguration - Input artifact to use for template parameters values and stack policy.
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.
this@Stability(value=Experimental) public CloudFormationCreateUpdateStackActionProps.Builder role(IRole role)
CommonAwsActionProps.getRole()role - 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.this@Stability(value=Experimental) public CloudFormationCreateUpdateStackActionProps.Builder actionName(String actionName)
CommonActionProps.getActionName()actionName - The physical, human-readable name of the Action. This parameter is required.
Note that Action names must be unique within a single Stage.this@Stability(value=Experimental) public CloudFormationCreateUpdateStackActionProps.Builder runOrder(Number runOrder)
CommonActionProps.getRunOrder()runOrder - The runOrder property for this Action.
RunOrder determines the relative order in which multiple Actions in the same Stage execute.this@Stability(value=Experimental) public CloudFormationCreateUpdateStackActionProps.Builder variablesNamespace(String variablesNamespace)
CommonActionProps.getVariablesNamespace()variablesNamespace - The name of the namespace to use for variables emitted by this action.this@Stability(value=Experimental) public CloudFormationCreateUpdateStackActionProps build()
build in interface software.amazon.jsii.Builder<CloudFormationCreateUpdateStackActionProps>CloudFormationCreateUpdateStackActionPropsNullPointerException - if any required attribute was not providedCopyright © 2021. All rights reserved.