software.amazon.awscdk.services.cloudformation.codepipeline

Interface CloudFormationDeploymentActionCommonProps

All Superinterfaces:

CloudFormationCommonProps, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

CreateReplaceChangeSetProps, CreateUpdateProps, DeleteStackOnlyProps

All Known Implementing Classes:

CloudFormationDeploymentActionCommonProps.Jsii$Pojo, CloudFormationDeploymentActionCommonProps.Jsii$Proxy, CreateReplaceChangeSetProps.Jsii$Pojo, CreateReplaceChangeSetProps.Jsii$Proxy, CreateUpdateProps.Jsii$Pojo, CreateUpdateProps.Jsii$Proxy, DeleteStackOnlyProps.Jsii$Proxy

public interface CloudFormationDeploymentActionCommonProps
extends software.amazon.jsii.JsiiSerializable, CloudFormationCommonProps

Properties common to CloudFormation actions that stage deployments

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CloudFormationDeploymentActionCommonProps.Builder A fluent step builder class for CloudFormationDeploymentActionCommonProps.
static class	CloudFormationDeploymentActionCommonProps.Jsii$Pojo A PoJo (plain-old-java-object) class that implements CloudFormationDeploymentActionCommonProps.
static class	CloudFormationDeploymentActionCommonProps.Jsii$Proxy A proxy class which for javascript object literal which adhere to this interface.

Method Summary

Modifier and Type	Method and Description
static CloudFormationDeploymentActionCommonProps.Builder	builder()
List<CloudFormationCapabilities>	getCapabilities() 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.
Boolean	getFullPermissions() Whether to grant full permissions to CloudFormation while deploying this template.
Map<String,Object>	getParameterOverrides() Additional template parameters.
software.amazon.awscdk.services.iam.Role	getRole() IAM role to assume when deploying changes.
software.amazon.awscdk.services.codepipeline.ArtifactPath	getTemplateConfiguration() Input artifact to use for template parameters values and stack policy.
void	setCapabilities(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.
void	setFullPermissions(Boolean value) Whether to grant full permissions to CloudFormation while deploying this template.
void	setParameterOverrides(Map<String,Object> value) Additional template parameters.
void	setRole(software.amazon.awscdk.services.iam.Role value) IAM role to assume when deploying changes.
void	setTemplateConfiguration(software.amazon.awscdk.services.codepipeline.ArtifactPath value) Input artifact to use for template parameters values and stack policy.

Methods inherited from interface software.amazon.awscdk.services.cloudformation.codepipeline.CloudFormationCommonProps

getOutputArtifactName, getOutputFileName, getStackName, setOutputArtifactName, setOutputFileName, setStackName

Method Detail

getRole

software.amazon.awscdk.services.iam.Role getRole()

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.

setRole

void setRole(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.

getCapabilities

List<CloudFormationCapabilities> getCapabilities()

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).

setCapabilities

void setCapabilities(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).

getFullPermissions

Boolean getFullPermissions()

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.

setFullPermissions

void setFullPermissions(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.

getTemplateConfiguration

software.amazon.awscdk.services.codepipeline.ArtifactPath getTemplateConfiguration()

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.

setTemplateConfiguration

void setTemplateConfiguration(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.

getParameterOverrides

Map<String,Object> getParameterOverrides()

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.

setParameterOverrides

void setParameterOverrides(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.

builder

static CloudFormationDeploymentActionCommonProps.Builder builder()

Specified by:

builder in interface CloudFormationCommonProps