software.amazon.awscdk.services.cloudformation.codepipeline

Interface CreateUpdateProps.Builder.Build

Enclosing class:

CreateUpdateProps.Builder

public static interface CreateUpdateProps.Builder.Build

Method Summary

Modifier and Type	Method and Description
CreateUpdateProps	build()
CreateUpdateProps.Builder.Build	withCapabilities(List<CloudFormationCapabilities> value) Acknowledge certain changes made as part of deployment For stacks that contain certain resources, explicit acknowledgement that AWS CloudFormation might create or update those resources.
CreateUpdateProps.Builder.Build	withFullPermissions(Boolean value) Whether to grant full permissions to CloudFormation while deploying this template.
CreateUpdateProps.Builder.Build	withOutputArtifactName(String value) The name of the output artifact to generate Only applied if `outputFileName` is set as well.
CreateUpdateProps.Builder.Build	withOutputFileName(String value) A name for the filename in the output artifact to store the AWS CloudFormation call's result.
CreateUpdateProps.Builder.Build	withParameterOverrides(Map<String,Object> value) Additional template parameters.
CreateUpdateProps.Builder.Build	withReplaceOnFailure(Boolean value) Replace the stack if it's in a failed state.
CreateUpdateProps.Builder.Build	withRole(software.amazon.awscdk.services.iam.Role value) IAM role to assume when deploying changes.
CreateUpdateProps.Builder.Build	withTemplateConfiguration(software.amazon.awscdk.services.codepipeline.ArtifactPath value) Input artifact to use for template parameters values and stack policy.

Method Detail

build

CreateUpdateProps build()

Returns:

a new CreateUpdateProps object, initialized with the values set on this builder.

withReplaceOnFailure

CreateUpdateProps.Builder.Build withReplaceOnFailure(Boolean value)

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.

withRole

CreateUpdateProps.Builder.Build withRole(software.amazon.awscdk.services.iam.Role value)

IAM role to assume when deploying changes. If not specified, a fresh role is created. The role is created with zero permissions unless `trustTemplate` is true, in which case the role will have full permissions.

withCapabilities

CreateUpdateProps.Builder.Build withCapabilities(List<CloudFormationCapabilities> value)

Acknowledge certain changes made as part of deployment For stacks that contain certain resources, explicit acknowledgement that AWS CloudFormation might create or update those resources. For example, you must specify CAPABILITY_IAM if your stack template contains AWS Identity and Access Management (IAM) resources. For more information, see [Acknowledging IAM Resources in AWS CloudFormation Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).

withFullPermissions

CreateUpdateProps.Builder.Build withFullPermissions(Boolean value)

Whether to grant full permissions to CloudFormation while deploying this template. 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.

withTemplateConfiguration

CreateUpdateProps.Builder.Build withTemplateConfiguration(software.amazon.awscdk.services.codepipeline.ArtifactPath value)

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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-cfn-artifacts.html). Note that if you include sensitive information, such as passwords, restrict access to this file.

withParameterOverrides

CreateUpdateProps.Builder.Build withParameterOverrides(Map<String,Object> value)

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.

withOutputFileName

CreateUpdateProps.Builder.Build withOutputFileName(String 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.

withOutputArtifactName

CreateUpdateProps.Builder.Build withOutputArtifactName(String value)

The name of the output artifact to generate Only applied if `outputFileName` is set as well.