Class DeployCdkStackAction
(deprecated) Action to deploy a CDK Stack.
Inheritance
Implements
Namespace: Amazon.CDK.Pipelines
Assembly: Amazon.CDK.Pipelines.dll
Syntax (csharp)
public class DeployCdkStackAction : DeputyBase, IAction
Syntax (vb)
Public Class DeployCdkStackAction
Inherits DeputyBase
Implements IAction
Remarks
Adds two CodePipeline Actions to the pipeline: one to create a ChangeSet and one to execute it.
You do not need to instantiate this action yourself -- it will automatically be added by the pipeline when you add stack artifacts or entire stages.
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 deployCdkStackAction = new DeployCdkStackAction(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
DeployCdkStackAction(IDeployCdkStackActionProps) | |
DeployCdkStackAction(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
DeployCdkStackAction(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
ActionProperties | (deprecated) Exists to implement IAction. |
DependencyStackArtifactIds | (deprecated) Artifact ids of the artifact this stack artifact depends on. |
ExecuteRunOrder | (deprecated) The runorder for the execute action. |
PrepareRunOrder | (deprecated) The runorder for the prepare action. |
StackArtifactId | (deprecated) Artifact id of the artifact this action was based on. |
StackName | (deprecated) Name of the deployed stack. |
Methods
Bind(Construct, IStage, IActionBindOptions) | (deprecated) Exists to implement IAction. |
FromStackArtifact(Construct, CloudFormationStackArtifact, ICdkStackActionFromArtifactOptions) | (deprecated) Construct a DeployCdkStackAction from a Stack artifact. |
OnStateChange(String, IRuleTarget, IRuleProps) | (deprecated) Exists to implement IAction. |
Constructors
DeployCdkStackAction(IDeployCdkStackActionProps)
public DeployCdkStackAction(IDeployCdkStackActionProps props)
Parameters
Remarks
Stability: Deprecated
DeployCdkStackAction(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected DeployCdkStackAction(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
DeployCdkStackAction(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected DeployCdkStackAction(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
ActionProperties
(deprecated) Exists to implement IAction.
public virtual IActionProperties ActionProperties { get; }
Property Value
Remarks
Stability: Deprecated
DependencyStackArtifactIds
(deprecated) Artifact ids of the artifact this stack artifact depends on.
public virtual string[] DependencyStackArtifactIds { get; }
Property Value
System.String[]
Remarks
Stability: Deprecated
ExecuteRunOrder
(deprecated) The runorder for the execute action.
public virtual double ExecuteRunOrder { get; }
Property Value
System.Double
Remarks
Stability: Deprecated
PrepareRunOrder
(deprecated) The runorder for the prepare action.
public virtual double PrepareRunOrder { get; }
Property Value
System.Double
Remarks
Stability: Deprecated
StackArtifactId
(deprecated) Artifact id of the artifact this action was based on.
public virtual string StackArtifactId { get; }
Property Value
System.String
Remarks
Stability: Deprecated
StackName
(deprecated) Name of the deployed stack.
public virtual string StackName { get; }
Property Value
System.String
Remarks
Stability: Deprecated
Methods
Bind(Construct, IStage, IActionBindOptions)
(deprecated) Exists to implement IAction.
public virtual IActionConfig Bind(Construct scope, IStage stage, IActionBindOptions options)
Parameters
- scope Construct
- stage IStage
- options IActionBindOptions
Returns
Remarks
Stability: Deprecated
FromStackArtifact(Construct, CloudFormationStackArtifact, ICdkStackActionFromArtifactOptions)
(deprecated) Construct a DeployCdkStackAction from a Stack artifact.
public static DeployCdkStackAction FromStackArtifact(Construct scope, CloudFormationStackArtifact artifact, ICdkStackActionFromArtifactOptions options)
Parameters
- scope Constructs.Construct
- artifact CloudFormationStackArtifact
- options ICdkStackActionFromArtifactOptions
Returns
Remarks
Stability: Deprecated
OnStateChange(String, IRuleTarget, IRuleProps)
(deprecated) Exists to implement IAction.
public virtual Rule OnStateChange(string name, IRuleTarget target = null, IRuleProps options = null)
Parameters
- name System.String
- target IRuleTarget
- options IRuleProps
Returns
Remarks
Stability: Deprecated