Class CodeDeployEcsDeployActionProps
Construction properties of the CodeDeployEcsDeployAction CodeDeploy ECS deploy CodePipeline Action
.
Inheritance
Namespace: Amazon.CDK.AWS.CodePipeline.Actions
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CodeDeployEcsDeployActionProps : Object, ICodeDeployEcsDeployActionProps, ICommonAwsActionProps, ICommonActionProps
Syntax (vb)
Public Class CodeDeployEcsDeployActionProps
Inherits Object
Implements ICodeDeployEcsDeployActionProps, 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.CodeDeploy;
using Amazon.CDK.AWS.CodePipeline;
using Amazon.CDK.AWS.CodePipeline.Actions;
using Amazon.CDK.AWS.IAM;
Artifact artifact;
ArtifactPath artifactPath;
EcsDeploymentGroup ecsDeploymentGroup;
Role role;
var codeDeployEcsDeployActionProps = new CodeDeployEcsDeployActionProps {
ActionName = "actionName",
DeploymentGroup = ecsDeploymentGroup,
// the properties below are optional
AppSpecTemplateFile = artifactPath,
AppSpecTemplateInput = artifact,
ContainerImageInputs = new [] { new CodeDeployEcsContainerImageInput {
Input = artifact,
// the properties below are optional
TaskDefinitionPlaceholder = "taskDefinitionPlaceholder"
} },
Role = role,
RunOrder = 123,
TaskDefinitionTemplateFile = artifactPath,
TaskDefinitionTemplateInput = artifact,
VariablesNamespace = "variablesNamespace"
};
Synopsis
Constructors
CodeDeployEcsDeployActionProps() |
Properties
ActionName | The physical, human-readable name of the Action. |
AppSpecTemplateFile | The name of the CodeDeploy AppSpec file. |
AppSpecTemplateInput | The artifact containing the CodeDeploy AppSpec file. |
ContainerImageInputs | Configuration for dynamically updated images in the task definition. |
DeploymentGroup | The CodeDeploy ECS Deployment Group to deploy to. |
Role | The Role in which context's this Action will be executing in. |
RunOrder | The runOrder property for this Action. |
TaskDefinitionTemplateFile | The name of the ECS task definition template file. |
TaskDefinitionTemplateInput | The artifact containing the ECS task definition template file. |
VariablesNamespace | The name of the namespace to use for variables emitted by this action. |
Constructors
CodeDeployEcsDeployActionProps()
public CodeDeployEcsDeployActionProps()
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.
AppSpecTemplateFile
The name of the CodeDeploy AppSpec file.
public ArtifactPath_ AppSpecTemplateFile { get; set; }
Property Value
Remarks
During deployment, a new task definition will be registered with ECS, and the new task definition ID will be inserted into the CodeDeploy AppSpec file. The AppSpec file contents will be provided to CodeDeploy for the deployment.
Use this property if you want to use a different name for this file than the default 'appspec.yaml'.
If you use this property, you don't need to specify the appSpecTemplateInput
property.
Default: - one of this property, or appSpecTemplateInput
, is required
AppSpecTemplateInput
The artifact containing the CodeDeploy AppSpec file.
public Artifact_ AppSpecTemplateInput { get; set; }
Property Value
Remarks
During deployment, a new task definition will be registered with ECS, and the new task definition ID will be inserted into the CodeDeploy AppSpec file. The AppSpec file contents will be provided to CodeDeploy for the deployment.
If you use this property, it's assumed the file is called 'appspec.yaml'.
If your AppSpec file uses a different filename, leave this property empty,
and use the appSpecTemplateFile
property instead.
Default: - one of this property, or appSpecTemplateFile
, is required
ContainerImageInputs
Configuration for dynamically updated images in the task definition.
public ICodeDeployEcsContainerImageInput[] ContainerImageInputs { get; set; }
Property Value
ICodeDeployEcsContainerImageInput[]
Remarks
Provide pairs of an image details input artifact and a placeholder string that will be used to dynamically update the ECS task definition template file prior to deployment. A maximum of 4 images can be given.
DeploymentGroup
The CodeDeploy ECS Deployment Group to deploy to.
public IEcsDeploymentGroup DeploymentGroup { 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 IAction.bind
method in the 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
TaskDefinitionTemplateFile
The name of the ECS task definition template file.
public ArtifactPath_ TaskDefinitionTemplateFile { get; set; }
Property Value
Remarks
During deployment, the task definition template file contents will be registered with ECS.
Use this property if you want to use a different name for this file than the default 'taskdef.json'.
If you use this property, you don't need to specify the taskDefinitionTemplateInput
property.
Default: - one of this property, or taskDefinitionTemplateInput
, is required
TaskDefinitionTemplateInput
The artifact containing the ECS task definition template file.
public Artifact_ TaskDefinitionTemplateInput { get; set; }
Property Value
Remarks
During deployment, the task definition template file contents will be registered with ECS.
If you use this property, it's assumed the file is called 'taskdef.json'.
If your task definition template uses a different filename, leave this property empty,
and use the taskDefinitionTemplateFile
property instead.
Default: - one of this property, or taskDefinitionTemplateFile
, is required
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