CloudFormationCreateUpdateStackActionProps.Jsii$Proxy (software.amazon.awscdk:codepipeline-actions 1.18.0 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.amazon.awscdk.services.codepipeline.actions.CloudFormationCreateUpdateStackActionProps.Jsii$Proxy

All Implemented Interfaces:

CloudFormationCreateUpdateStackActionProps, CommonActionProps, CommonAwsActionProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CloudFormationCreateUpdateStackActionProps
```
@Stability(value=Stable)
public static final class CloudFormationCreateUpdateStackActionProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CloudFormationCreateUpdateStackActionProps
```
An implementation for CloudFormationCreateUpdateStackActionProps

Nested Class Summary
- Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
  software.amazon.jsii.JsiiObject.InitializationMode
- Nested classes/interfaces inherited from interface software.amazon.awscdk.services.codepipeline.actions.CloudFormationCreateUpdateStackActionProps
  CloudFormationCreateUpdateStackActionProps.Builder, CloudFormationCreateUpdateStackActionProps.Jsii$Proxy

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)` Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.fasterxml.jackson.databind.JsonNode`	`$jsii$toJson()`
`boolean`	`equals(Object o)`
`String`	`getAccount()` The AWS account this Action is supposed to operate in.
`String`	`getActionName()`
`Boolean`	`getAdminPermissions()` Whether to grant full permissions to CloudFormation while deploying this template.
`List<CloudFormationCapabilities>`	`getCapabilities()` Acknowledge certain changes made as part of deployment.
`IRole`	`getDeploymentRole()` IAM role to assume when deploying changes.
`List<Artifact>`	`getExtraInputs()` The list of additional input Artifacts for this Action.
`Artifact`	`getOutput()` The name of the output artifact to generate.
`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.
`String`	`getRegion()` The AWS region the given Action resides in.
`Boolean`	`getReplaceOnFailure()` Replace the stack if it's in a failed state.
`IRole`	`getRole()`
`Number`	`getRunOrder()`
`String`	`getStackName()` The name of the stack to apply this action to.
`ArtifactPath`	`getTemplateConfiguration()` Input artifact to use for template parameters values and stack policy.
`ArtifactPath`	`getTemplatePath()` Input artifact with the CloudFormation template to deploy.
`int`	`hashCode()`

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiCall, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticGet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.services.codepipeline.actions.CloudFormationCreateUpdateStackActionProps
builder

- Constructor Detail
  - Jsii$Proxy
```
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
```
    Constructor that initializes the object based on values retrieved from the JsiiObject.
    
    Parameters:
    
    objRef - Reference to the JSII managed object.
- Method Detail
  - getAdminPermissions
```
public Boolean getAdminPermissions()
```
    Description copied from interface: CloudFormationCreateUpdateStackActionProps
    
    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:
    
    getAdminPermissions in interface CloudFormationCreateUpdateStackActionProps
  - getStackName
```
public String getStackName()
```
    Description copied from interface: CloudFormationCreateUpdateStackActionProps
    
    The name of the stack to apply this action to.
    
    Specified by:
    
    getStackName in interface CloudFormationCreateUpdateStackActionProps
  - getTemplatePath
```
public ArtifactPath getTemplatePath()
```
    Description copied from interface: CloudFormationCreateUpdateStackActionProps
    
    Input artifact with the CloudFormation template to deploy.
    
    Specified by:
    
    getTemplatePath in interface CloudFormationCreateUpdateStackActionProps
  - getAccount
```
public String getAccount()
```
    Description copied from interface: CloudFormationCreateUpdateStackActionProps
    
    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. Default: - action resides in the same account as the pipeline
    
    Specified by:
    
    getAccount in interface CloudFormationCreateUpdateStackActionProps
  - getCapabilities
```
public List<CloudFormationCapabilities> getCapabilities()
```
    Description copied from interface: CloudFormationCreateUpdateStackActionProps
    
    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 AnonymousIAM or NamedIAM if your stack template contains AWS Identity and Access Management (IAM) resources. For more information see the link below.
    Default: None, unless `adminPermissions` is true
    
    Specified by:
    
    getCapabilities in interface CloudFormationCreateUpdateStackActionProps
    
    See Also:
    
    https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities
  - getDeploymentRole
```
public IRole getDeploymentRole()
```
    Description copied from interface: CloudFormationCreateUpdateStackActionProps
    
    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.
    Default: A fresh role with full or no permissions (depending on the value of `adminPermissions`).
    
    Specified by:
    
    getDeploymentRole in interface CloudFormationCreateUpdateStackActionProps
  - getExtraInputs
```
public List<Artifact> getExtraInputs()
```
    Description copied from interface: CloudFormationCreateUpdateStackActionProps
    
    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.
    
    Specified by:
    
    getExtraInputs in interface CloudFormationCreateUpdateStackActionProps
  - getOutput
```
public Artifact getOutput()
```
    Description copied from interface: CloudFormationCreateUpdateStackActionProps
    
    The name of the output artifact to generate.
    Only applied if outputFileName is set as well.
    Default: Automatically generated artifact name.
    
    Specified by:
    
    getOutput in interface CloudFormationCreateUpdateStackActionProps
  - getOutputFileName
```
public String getOutputFileName()
```
    Description copied from interface: CloudFormationCreateUpdateStackActionProps
    
    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.
    Default: No output artifact generated
    
    Specified by:
    
    getOutputFileName in interface CloudFormationCreateUpdateStackActionProps
  - getParameterOverrides
```
public Map<String,Object> getParameterOverrides()
```
    Description copied from interface: CloudFormationCreateUpdateStackActionProps
    
    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.
    Default: No overrides
    
    Specified by:
    
    getParameterOverrides in interface CloudFormationCreateUpdateStackActionProps
  - getRegion
```
public String getRegion()
```
    Description copied from interface: CloudFormationCreateUpdateStackActionProps
    
    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 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. Default: the Action resides in the same region as the Pipeline
    
    Specified by:
    
    getRegion in interface CloudFormationCreateUpdateStackActionProps
  - getReplaceOnFailure
```
public Boolean getReplaceOnFailure()
```
    Description copied from interface: CloudFormationCreateUpdateStackActionProps
    
    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.
    Default: false
    
    Specified by:
    
    getReplaceOnFailure in interface CloudFormationCreateUpdateStackActionProps
  - getTemplateConfiguration
```
public ArtifactPath getTemplateConfiguration()
```
    Description copied from interface: CloudFormationCreateUpdateStackActionProps
    
    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.
    Default: No template configuration based on input artifacts
    
    Specified by:
    
    getTemplateConfiguration in interface CloudFormationCreateUpdateStackActionProps
  - getRole
```
public IRole getRole()
```
    Specified by:
    
    getRole in interface CommonAwsActionProps
  - getActionName
```
public String getActionName()
```
    Specified by:
    
    getActionName in interface CommonActionProps
  - getRunOrder
```
public Number getRunOrder()
```
    Specified by:
    
    getRunOrder in interface CommonActionProps
  - $jsii$toJson
```
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
```
    Specified by:
    
    $jsii$toJson in interface software.amazon.jsii.JsiiSerializable
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class CloudFormationCreateUpdateStackActionProps.Jsii$Proxy

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.codepipeline.actions.CloudFormationCreateUpdateStackActionProps

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awscdk.services.codepipeline.actions.CloudFormationCreateUpdateStackActionProps

Constructor Detail

Jsii$Proxy

Method Detail

getAdminPermissions

getStackName

getTemplatePath

getAccount

getCapabilities

getDeploymentRole

getExtraInputs

getOutput

getOutputFileName

getParameterOverrides

getRegion

getReplaceOnFailure

getTemplateConfiguration

getRole

getActionName

getRunOrder

$jsii$toJson

equals

hashCode