software.amazon.awscdk.services.cloudformation.codepipeline

Class CloudFormationDeploymentActionCommonProps.Jsii$Pojo

java.lang.Object

software.amazon.awscdk.services.cloudformation.codepipeline.CloudFormationDeploymentActionCommonProps.Jsii$Pojo

All Implemented Interfaces:

CloudFormationCommonProps, CloudFormationDeploymentActionCommonProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CloudFormationDeploymentActionCommonProps

public static final class CloudFormationDeploymentActionCommonProps.Jsii$Pojo
extends Object
implements CloudFormationDeploymentActionCommonProps

A PoJo (plain-old-java-object) class that implements CloudFormationDeploymentActionCommonProps.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cloudformation.codepipeline.CloudFormationDeploymentActionCommonProps

CloudFormationDeploymentActionCommonProps.Builder, CloudFormationDeploymentActionCommonProps.Jsii$Pojo, CloudFormationDeploymentActionCommonProps.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field and Description
protected List<CloudFormationCapabilities>	_capabilities
protected Boolean	_fullPermissions
protected String	_outputArtifactName
protected String	_outputFileName
protected Map<String,Object>	_parameterOverrides
protected software.amazon.awscdk.services.iam.Role	_role
protected String	_stackName
protected software.amazon.awscdk.services.codepipeline.ArtifactPath	_templateConfiguration

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Pojo() Constructor used by builders.

Method Summary

Modifier and Type	Method and Description
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.
String	getOutputArtifactName() The name of the output artifact to generate Only applied if `outputFileName` is set as well.
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.
software.amazon.awscdk.services.iam.Role	getRole() IAM role to assume when deploying changes.
String	getStackName() The name of the stack to apply this action to
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	setOutputArtifactName(String value) The name of the output artifact to generate Only applied if `outputFileName` is set as well.
void	setOutputFileName(String value) A name for the filename in the output artifact to store the AWS CloudFormation call's result.
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	setStackName(String value) The name of the stack to apply this action to
void	setTemplateConfiguration(software.amazon.awscdk.services.codepipeline.ArtifactPath value) Input artifact to use for template parameters values and stack policy.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

builder

Field Detail

_role

protected software.amazon.awscdk.services.iam.Role _role

_capabilities

protected List<CloudFormationCapabilities> _capabilities

_fullPermissions

protected Boolean _fullPermissions

_templateConfiguration

protected software.amazon.awscdk.services.codepipeline.ArtifactPath _templateConfiguration

_parameterOverrides

protected Map<String,Object> _parameterOverrides

_stackName

protected String _stackName

_outputFileName

protected String _outputFileName

_outputArtifactName

protected String _outputArtifactName

Constructor Detail

Jsii$Pojo

protected Jsii$Pojo()

Constructor used by builders.

Method Detail

getRole

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

Description copied from interface: CloudFormationDeploymentActionCommonProps

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.

Specified by:

getRole in interface CloudFormationDeploymentActionCommonProps

setRole

public void setRole(software.amazon.awscdk.services.iam.Role value)

Description copied from interface: CloudFormationDeploymentActionCommonProps

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.

Specified by:

setRole in interface CloudFormationDeploymentActionCommonProps

getCapabilities

public List<CloudFormationCapabilities> getCapabilities()

Description copied from interface: CloudFormationDeploymentActionCommonProps

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

Specified by:

getCapabilities in interface CloudFormationDeploymentActionCommonProps

setCapabilities

public void setCapabilities(List<CloudFormationCapabilities> value)

Description copied from interface: CloudFormationDeploymentActionCommonProps

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

Specified by:

setCapabilities in interface CloudFormationDeploymentActionCommonProps

getFullPermissions

public Boolean getFullPermissions()

Description copied from interface: CloudFormationDeploymentActionCommonProps

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.

Specified by:

getFullPermissions in interface CloudFormationDeploymentActionCommonProps

setFullPermissions

public void setFullPermissions(Boolean value)

Description copied from interface: CloudFormationDeploymentActionCommonProps

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.

Specified by:

setFullPermissions in interface CloudFormationDeploymentActionCommonProps

getTemplateConfiguration

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

Description copied from interface: CloudFormationDeploymentActionCommonProps

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.

Specified by:

getTemplateConfiguration in interface CloudFormationDeploymentActionCommonProps

setTemplateConfiguration

public void setTemplateConfiguration(software.amazon.awscdk.services.codepipeline.ArtifactPath value)

Description copied from interface: CloudFormationDeploymentActionCommonProps

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.

Specified by:

setTemplateConfiguration in interface CloudFormationDeploymentActionCommonProps

getParameterOverrides

public Map<String,Object> getParameterOverrides()

Description copied from interface: CloudFormationDeploymentActionCommonProps

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.

Specified by:

getParameterOverrides in interface CloudFormationDeploymentActionCommonProps

setParameterOverrides

public void setParameterOverrides(Map<String,Object> value)

Description copied from interface: CloudFormationDeploymentActionCommonProps

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.

Specified by:

setParameterOverrides in interface CloudFormationDeploymentActionCommonProps

getStackName

public String getStackName()

Description copied from interface: CloudFormationCommonProps

The name of the stack to apply this action to

Specified by:

getStackName in interface CloudFormationCommonProps

setStackName

public void setStackName(String value)

Description copied from interface: CloudFormationCommonProps

The name of the stack to apply this action to

Specified by:

setStackName in interface CloudFormationCommonProps

getOutputFileName

public String getOutputFileName()

Description copied from interface: CloudFormationCommonProps

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.

Specified by:

getOutputFileName in interface CloudFormationCommonProps

setOutputFileName

public void setOutputFileName(String value)

Description copied from interface: CloudFormationCommonProps

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.

Specified by:

setOutputFileName in interface CloudFormationCommonProps

getOutputArtifactName

public String getOutputArtifactName()

Description copied from interface: CloudFormationCommonProps

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

Specified by:

getOutputArtifactName in interface CloudFormationCommonProps

setOutputArtifactName

public void setOutputArtifactName(String value)

Description copied from interface: CloudFormationCommonProps

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

Specified by:

setOutputArtifactName in interface CloudFormationCommonProps