CreateUpdateProps.Jsii$Pojo (software.amazon.awscdk:cloudformation-codepipeline 0.8.1 API)

java.lang.Object
- software.amazon.awscdk.services.cloudformation.codepipeline.CreateUpdateProps.Jsii$Pojo

All Implemented Interfaces:

CloudFormationCommonProps, CloudFormationDeploymentActionCommonProps, CreateUpdateProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CreateUpdateProps
```
public static final class CreateUpdateProps.Jsii$Pojo
extends Object
implements CreateUpdateProps
```
A PoJo (plain-old-java-object) class that implements CreateUpdateProps.

Nested Class Summary
- Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cloudformation.codepipeline.CreateUpdateProps
  CreateUpdateProps.Builder, CreateUpdateProps.Jsii$Pojo, CreateUpdateProps.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 Boolean`	`_replaceOnFailure`
`protected software.amazon.awscdk.services.iam.Role`	`_role`
`protected String`	`_stackName`
`protected software.amazon.awscdk.services.codepipeline.ArtifactPath`	`_templateConfiguration`
`protected software.amazon.awscdk.services.codepipeline.ArtifactPath`	`_templatePath`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Jsii$Pojo()
Constructor used by builders.

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

Method Summary

All Methods Instance Methods Concrete Methods
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.
`Boolean`	`getReplaceOnFailure()` Replace the stack if it's in a failed state.
`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.
`software.amazon.awscdk.services.codepipeline.ArtifactPath`	`getTemplatePath()` Input artifact with the CloudFormation template to deploy
`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`	`setReplaceOnFailure(Boolean value)` Replace the stack if it's in a failed state.
`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.
`void`	`setTemplatePath(software.amazon.awscdk.services.codepipeline.ArtifactPath value)` Input artifact with the CloudFormation template to deploy

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.CreateUpdateProps
builder

- Field Detail
  - _templatePath
```
protected software.amazon.awscdk.services.codepipeline.ArtifactPath _templatePath
```
  - _replaceOnFailure
```
protected Boolean _replaceOnFailure
```
  - _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
  - getTemplatePath
```
public software.amazon.awscdk.services.codepipeline.ArtifactPath getTemplatePath()
```
    Description copied from interface: CreateUpdateProps
    
    Input artifact with the CloudFormation template to deploy
    
    Specified by:
    
    getTemplatePath in interface CreateUpdateProps
  - setTemplatePath
```
public void setTemplatePath(software.amazon.awscdk.services.codepipeline.ArtifactPath value)
```
    Description copied from interface: CreateUpdateProps
    
    Input artifact with the CloudFormation template to deploy
    
    Specified by:
    
    setTemplatePath in interface CreateUpdateProps
  - getReplaceOnFailure
```
public Boolean getReplaceOnFailure()
```
    Description copied from interface: CreateUpdateProps
    
    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.
    
    Specified by:
    
    getReplaceOnFailure in interface CreateUpdateProps
  - setReplaceOnFailure
```
public void setReplaceOnFailure(Boolean value)
```
    Description copied from interface: CreateUpdateProps
    
    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.
    
    Specified by:
    
    setReplaceOnFailure in interface CreateUpdateProps
  - 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

Class CreateUpdateProps.Jsii$Pojo

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

_templatePath

_replaceOnFailure

_role

_capabilities

_fullPermissions

_templateConfiguration

_parameterOverrides

_stackName

_outputFileName

_outputArtifactName

Constructor Detail

Jsii$Pojo

Method Detail

getTemplatePath

setTemplatePath

getReplaceOnFailure

setReplaceOnFailure

getRole

setRole

getCapabilities

setCapabilities

getFullPermissions

setFullPermissions

getTemplateConfiguration

setTemplateConfiguration

getParameterOverrides

setParameterOverrides

getStackName

setStackName

getOutputFileName

setOutputFileName

getOutputArtifactName

setOutputArtifactName