Class CodeDeployServerDeployActionProps
Construction properties of the {@link CodeDeployServerDeployAction CodeDeploy server deploy CodePipeline Action}.
Inheritance
Namespace: Amazon.CDK.AWS.CodePipeline.Actions
Assembly: Amazon.CDK.AWS.CodePipeline.Actions.dll
Syntax (csharp)
public class CodeDeployServerDeployActionProps : Object, ICodeDeployServerDeployActionProps, ICommonAwsActionProps, ICommonActionProps
Syntax (vb)
Public Class CodeDeployServerDeployActionProps
Inherits Object
Implements ICodeDeployServerDeployActionProps, ICommonAwsActionProps, ICommonActionProps
Remarks
ExampleMetadata: infused
Examples
ServerDeploymentGroup deploymentGroup;
var pipeline = new Pipeline(this, "MyPipeline", new PipelineProps {
PipelineName = "MyPipeline"
});
// add the source and build Stages to the Pipeline...
var buildOutput = new Artifact();
var deployAction = new CodeDeployServerDeployAction(new CodeDeployServerDeployActionProps {
ActionName = "CodeDeploy",
Input = buildOutput,
DeploymentGroup = deploymentGroup
});
pipeline.AddStage(new StageOptions {
StageName = "Deploy",
Actions = new [] { deployAction }
});
Synopsis
Constructors
CodeDeployServerDeployActionProps() |
Properties
ActionName | The physical, human-readable name of the Action. |
DeploymentGroup | The CodeDeploy server Deployment Group to deploy to. |
Input | The source to use as input for deployment. |
Role | The Role in which context's this Action will be executing in. |
RunOrder | The runOrder property for this Action. |
VariablesNamespace | The name of the namespace to use for variables emitted by this action. |
Constructors
CodeDeployServerDeployActionProps()
public CodeDeployServerDeployActionProps()
Properties
ActionName
The physical, human-readable name of the Action.
public string ActionName { get; set; }
Property Value
System.String
Remarks
Note that Action names must be unique within a single Stage.
DeploymentGroup
The CodeDeploy server Deployment Group to deploy to.
public IServerDeploymentGroup DeploymentGroup { get; set; }
Property Value
Input
The source to use as input for deployment.
public Artifact_ Input { get; set; }
Property Value
Role
The Role in which context's this Action will be executing in.
public IRole Role { get; set; }
Property Value
Remarks
The Pipeline's Role will assume this Role (the required permissions for that will be granted automatically) right before executing this Action. This Action will be passed into your {@link IAction.bind} method in the {@link ActionBindOptions.role} property.
Default: a new Role will be generated
RunOrder
The runOrder property for this Action.
public Nullable<double> RunOrder { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
RunOrder determines the relative order in which multiple Actions in the same Stage execute.
Default: 1
See: https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html
VariablesNamespace
The name of the namespace to use for variables emitted by this action.
public string VariablesNamespace { get; set; }
Property Value
System.String
Remarks
Default: - a name will be generated, based on the stage and action names, if any of the action's variables were referenced - otherwise, no namespace will be set