@Stability(value=Stable) public static final class CloudFormationDeleteStackActionProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CloudFormationDeleteStackActionProps
CloudFormationDeleteStackActionPropssoftware.amazon.jsii.JsiiObject.InitializationModeCloudFormationDeleteStackActionProps.Builder, CloudFormationDeleteStackActionProps.Jsii$Proxy| Modifier | Constructor and Description |
|---|---|
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
| 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.
|
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.
|
int |
hashCode() |
jsiiAsyncCall, jsiiCall, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticGet, jsiiStaticSetclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitbuilderprotected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef - Reference to the JSII managed object.public Boolean getAdminPermissions()
CloudFormationDeleteStackActionPropsSetting 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.
getAdminPermissions in interface CloudFormationDeleteStackActionPropspublic String getStackName()
CloudFormationDeleteStackActionPropsgetStackName in interface CloudFormationDeleteStackActionPropspublic String getAccount()
CloudFormationDeleteStackActionPropsgetAccount in interface CloudFormationDeleteStackActionPropspublic List<CloudFormationCapabilities> getCapabilities()
CloudFormationDeleteStackActionPropsFor 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.
getCapabilities in interface CloudFormationDeleteStackActionPropshttps://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilitiespublic IRole getDeploymentRole()
CloudFormationDeleteStackActionPropsIf 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.
getDeploymentRole in interface CloudFormationDeleteStackActionPropspublic List<Artifact> getExtraInputs()
CloudFormationDeleteStackActionPropsparameterOverrides: { '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.
getExtraInputs in interface CloudFormationDeleteStackActionPropspublic Artifact getOutput()
CloudFormationDeleteStackActionPropsOnly applied if outputFileName is set as well.
getOutput in interface CloudFormationDeleteStackActionPropspublic String getOutputFileName()
CloudFormationDeleteStackActionPropsThe 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 generatedgetOutputFileName in interface CloudFormationDeleteStackActionPropspublic Map<String,Object> getParameterOverrides()
CloudFormationDeleteStackActionPropsTemplate 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 overridesgetParameterOverrides in interface CloudFormationDeleteStackActionPropspublic String getRegion()
CloudFormationDeleteStackActionPropsPipelineProps#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 PipelinegetRegion in interface CloudFormationDeleteStackActionPropspublic ArtifactPath getTemplateConfiguration()
CloudFormationDeleteStackActionPropsThe 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 artifactsgetTemplateConfiguration in interface CloudFormationDeleteStackActionPropspublic IRole getRole()
getRole in interface CommonAwsActionPropspublic String getActionName()
getActionName in interface CommonActionPropspublic Number getRunOrder()
getRunOrder in interface CommonActionPropspublic com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
$jsii$toJson in interface software.amazon.jsii.JsiiSerializableCopyright © 2019. All rights reserved.