Interface ICloudFormationDeleteStackActionProps
Properties for the CloudFormationDeleteStackAction.
Inherited Members
Namespace: Amazon.CDK.AWS.CodePipeline.Actions
Assembly: Amazon.CDK.AWS.CodePipeline.Actions.dll
Syntax (csharp)
public interface ICloudFormationDeleteStackActionProps : ICommonAwsActionProps, ICommonActionProps
Syntax (vb)
Public Interface ICloudFormationDeleteStackActionProps
Inherits ICommonAwsActionProps, ICommonActionProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CloudFormation;
using Amazon.CDK.AWS.CodePipeline;
using Amazon.CDK.AWS.CodePipeline.Actions;
using Amazon.CDK.AWS.IAM;
using Amazon.CDK;
Artifact artifact;
ArtifactPath artifactPath;
var parameterOverrides;
Role role;
var cloudFormationDeleteStackActionProps = new CloudFormationDeleteStackActionProps {
ActionName = "actionName",
AdminPermissions = false,
StackName = "stackName",
// the properties below are optional
Account = "account",
Capabilities = new [] { CloudFormationCapabilities.NONE },
CfnCapabilities = new [] { CfnCapabilities.NONE },
DeploymentRole = role,
ExtraInputs = new [] { artifact },
Output = artifact,
OutputFileName = "outputFileName",
ParameterOverrides = new Dictionary<string, object> {
{ "parameterOverridesKey", parameterOverrides }
},
Region = "region",
Role = role,
RunOrder = 123,
TemplateConfiguration = artifactPath,
VariablesNamespace = "variablesNamespace"
};
Synopsis
Properties
Account | The AWS account this Action is supposed to operate in. |
AdminPermissions | Whether to grant full permissions to CloudFormation while deploying this template. |
Capabilities | (deprecated) Acknowledge certain changes made as part of deployment. |
CfnCapabilities | Acknowledge certain changes made as part of deployment. |
DeploymentRole | IAM role to assume when deploying changes. |
ExtraInputs | The list of additional input Artifacts for this Action. |
Output | The name of the output artifact to generate. |
OutputFileName | A name for the filename in the output artifact to store the AWS CloudFormation call's result. |
ParameterOverrides | Additional template parameters. |
Region | The AWS region the given Action resides in. |
StackName | The name of the stack to apply this action to. |
TemplateConfiguration | Input artifact to use for template parameters values and stack policy. |
Properties
Account
The AWS account this Action is supposed to operate in.
virtual string Account { get; }
Property Value
System.String
Remarks
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
AdminPermissions
Whether to grant full permissions to CloudFormation while deploying this template.
bool AdminPermissions { get; }
Property Value
System.Boolean
Remarks
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.
Capabilities
(deprecated) Acknowledge certain changes made as part of deployment.
virtual CloudFormationCapabilities[] Capabilities { get; }
Property Value
Remarks
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
Stability: Deprecated
CfnCapabilities
Acknowledge certain changes made as part of deployment.
virtual CfnCapabilities[] CfnCapabilities { get; }
Property Value
Remarks
For stacks that contain certain resources,
explicit acknowledgement is required that AWS CloudFormation might create or update those resources.
For example, you must specify ANONYMOUS_IAM
or NAMED_IAM
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
DeploymentRole
IAM role to assume when deploying changes.
virtual IRole DeploymentRole { get; }
Property Value
Remarks
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
).
ExtraInputs
The list of additional input Artifacts for this Action.
virtual Artifact_[] ExtraInputs { get; }
Property Value
Remarks
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.
Output
The name of the output artifact to generate.
virtual Artifact_ Output { get; }
Property Value
Remarks
Only applied if outputFileName
is set as well.
Default: Automatically generated artifact name.
OutputFileName
A name for the filename in the output artifact to store the AWS CloudFormation call's result.
virtual string OutputFileName { get; }
Property Value
System.String
Remarks
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
ParameterOverrides
Additional template parameters.
virtual IDictionary<string, object> ParameterOverrides { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Remarks
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
Region
The AWS region the given Action resides in.
virtual string Region { get; }
Property Value
System.String
Remarks
Note that a cross-region Pipeline requires replication buckets to function correctly.
You can provide their names with the {@link 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
StackName
The name of the stack to apply this action to.
string StackName { get; }
Property Value
System.String
TemplateConfiguration
Input artifact to use for template parameters values and stack policy.
virtual ArtifactPath_ TemplateConfiguration { get; }
Property Value
Remarks
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