Class DeployCdkStackActionProps
(deprecated) Properties for a DeployCdkStackAction.
Inheritance
Namespace: Amazon.CDK.Pipelines
Assembly: Amazon.CDK.Pipelines.dll
Syntax (csharp)
public class DeployCdkStackActionProps : Object, IDeployCdkStackActionProps, IDeployCdkStackActionOptions
Syntax (vb)
Public Class DeployCdkStackActionProps
Inherits Object
Implements IDeployCdkStackActionProps, IDeployCdkStackActionOptions
Remarks
Stability: Deprecated
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.CodePipeline;
using Amazon.CDK.AWS.IAM;
using Amazon.CDK.Pipelines;
Artifact artifact;
Role role;
var deployCdkStackActionProps = new DeployCdkStackActionProps {
ActionRole = role,
CloudAssemblyInput = artifact,
StackName = "stackName",
TemplatePath = "templatePath",
// the properties below are optional
BaseActionName = "baseActionName",
ChangeSetName = "changeSetName",
CloudFormationExecutionRole = role,
DependencyStackArtifactIds = new [] { "dependencyStackArtifactIds" },
ExecuteRunOrder = 123,
Output = artifact,
OutputFileName = "outputFileName",
PrepareRunOrder = 123,
Region = "region",
StackArtifactId = "stackArtifactId",
TemplateConfigurationPath = "templateConfigurationPath"
};
Synopsis
Constructors
DeployCdkStackActionProps() |
Properties
ActionRole | (deprecated) Role for the action to assume. |
BaseActionName | (deprecated) Base name of the action. |
ChangeSetName | (deprecated) Name of the change set to create and deploy. |
CloudAssemblyInput | (deprecated) The CodePipeline artifact that holds the Cloud Assembly. |
CloudFormationExecutionRole | (deprecated) Role to execute CloudFormation under. |
DependencyStackArtifactIds | (deprecated) Artifact ID for the stacks this stack depends on. |
ExecuteRunOrder | (deprecated) Run order for the Execute action. |
Output | (deprecated) Artifact to write Stack Outputs to. |
OutputFileName | (deprecated) Filename in output to write Stack outputs to. |
PrepareRunOrder | (deprecated) Run order for the Prepare action. |
Region | (deprecated) Region to deploy into. |
StackArtifactId | (deprecated) Artifact ID for the stack deployed here. |
StackName | (deprecated) The name of the stack that should be created/updated. |
TemplateConfigurationPath | (deprecated) Template configuration path relative to the input artifact. |
TemplatePath | (deprecated) Relative path of template in the input artifact. |
Constructors
DeployCdkStackActionProps()
public DeployCdkStackActionProps()
Properties
ActionRole
(deprecated) Role for the action to assume.
public IRole ActionRole { get; set; }
Property Value
Remarks
This controls the account to deploy into
Stability: Deprecated
BaseActionName
(deprecated) Base name of the action.
public string BaseActionName { get; set; }
Property Value
System.String
Remarks
Default: stackName
Stability: Deprecated
ChangeSetName
(deprecated) Name of the change set to create and deploy.
public string ChangeSetName { get; set; }
Property Value
System.String
Remarks
Default: 'PipelineChange'
Stability: Deprecated
CloudAssemblyInput
(deprecated) The CodePipeline artifact that holds the Cloud Assembly.
public Artifact_ CloudAssemblyInput { get; set; }
Property Value
Remarks
Stability: Deprecated
CloudFormationExecutionRole
(deprecated) Role to execute CloudFormation under.
public IRole CloudFormationExecutionRole { get; set; }
Property Value
Remarks
Default: - Execute CloudFormation using the action role
Stability: Deprecated
DependencyStackArtifactIds
(deprecated) Artifact ID for the stacks this stack depends on.
public string[] DependencyStackArtifactIds { get; set; }
Property Value
System.String[]
Remarks
Used for pipeline order checking.
Default: - No dependencies
Stability: Deprecated
ExecuteRunOrder
(deprecated) Run order for the Execute action.
public Nullable<double> ExecuteRunOrder { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: - prepareRunOrder + 1
Stability: Deprecated
Output
(deprecated) Artifact to write Stack Outputs to.
public Artifact_ Output { get; set; }
Property Value
Remarks
Default: - No outputs
Stability: Deprecated
OutputFileName
(deprecated) Filename in output to write Stack outputs to.
public string OutputFileName { get; set; }
Property Value
System.String
Remarks
Default: - Required when 'output' is set
Stability: Deprecated
PrepareRunOrder
(deprecated) Run order for the Prepare action.
public Nullable<double> PrepareRunOrder { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: 1
Stability: Deprecated
Region
(deprecated) Region to deploy into.
public string Region { get; set; }
Property Value
System.String
Remarks
Default: - Same region as pipeline
Stability: Deprecated
StackArtifactId
(deprecated) Artifact ID for the stack deployed here.
public string StackArtifactId { get; set; }
Property Value
System.String
Remarks
Used for pipeline order checking.
Default: - Order will not be checked
Stability: Deprecated
StackName
(deprecated) The name of the stack that should be created/updated.
public string StackName { get; set; }
Property Value
System.String
Remarks
Stability: Deprecated
TemplateConfigurationPath
(deprecated) Template configuration path relative to the input artifact.
public string TemplateConfigurationPath { get; set; }
Property Value
System.String
Remarks
Default: - No template configuration
Stability: Deprecated
TemplatePath
(deprecated) Relative path of template in the input artifact.
public string TemplatePath { get; set; }
Property Value
System.String
Remarks
Stability: Deprecated