interface CodeDeployServerDeployActionProps

Language	Type name
.NET	`Amazon.CDK.AWS.CodePipeline.Actions.CodeDeployServerDeployActionProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscodepipelineactions#CodeDeployServerDeployActionProps`
Java	`software.amazon.awscdk.services.codepipeline.actions.CodeDeployServerDeployActionProps`
Python	`aws_cdk.aws_codepipeline_actions.CodeDeployServerDeployActionProps`
TypeScript (source)	`aws-cdk-lib` » `aws_codepipeline_actions` » `CodeDeployServerDeployActionProps`

Construction properties of the CodeDeployServerDeployAction CodeDeploy server deploy CodePipeline Action.

Example

const pipeline = new codepipeline.Pipeline(this, 'MyPipeline', {
  pipelineName: 'MyPipeline',
});

// add the source and build Stages to the Pipeline...
const buildOutput = new codepipeline.Artifact();
declare const deploymentGroup: codedeploy.ServerDeploymentGroup;
const deployAction = new codepipeline_actions.CodeDeployServerDeployAction({
  actionName: 'CodeDeploy',
  input: buildOutput,
  deploymentGroup,
});
pipeline.addStage({
  stageName: 'Deploy',
  actions: [deployAction],
});

Properties

Name	Type	Description
actionName	`string`	The physical, human-readable name of the Action.
deploymentGroup	`IServerDeploymentGroup`	The CodeDeploy server Deployment Group to deploy to.
input	`Artifact`	The source to use as input for deployment.
role?	`IRole`	The Role in which context's this Action will be executing in.
runOrder?	`number`	The runOrder property for this Action.
variablesNamespace?	`string`	The name of the namespace to use for variables emitted by this action.

actionName

Type: string

The physical, human-readable name of the Action.

Note that Action names must be unique within a single Stage.

deploymentGroup

Type: IServerDeploymentGroup

The CodeDeploy server Deployment Group to deploy to.

input

Type: Artifact

The source to use as input for deployment.

role?

Type: IRole (optional, default: a new Role will be generated)

The Role in which context's this Action will be executing in.

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 IAction.bind method in the ActionBindOptions.role property.

runOrder?

Type: number (optional, default: 1)

The runOrder property for this Action.

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

variablesNamespace?

Type: string (optional, 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)

The name of the namespace to use for variables emitted by this action.