Interface ICodeDeployEcsDeployActionProps
Construction properties of the CodeDeployEcsDeployAction CodeDeploy ECS deploy CodePipeline Action
.
Inherited Members
Namespace: Amazon.CDK.AWS.CodePipeline.Actions
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICodeDeployEcsDeployActionProps : ICommonAwsActionProps, ICommonActionProps
Syntax (vb)
Public Interface ICodeDeployEcsDeployActionProps
Inherits 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
Properties
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. |
TaskDefinitionTemplateFile | The name of the ECS task definition template file. |
TaskDefinitionTemplateInput | The artifact containing the ECS task definition template file. |
Properties
AppSpecTemplateFile
The name of the CodeDeploy AppSpec file.
virtual ArtifactPath_ AppSpecTemplateFile { get; }
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.
virtual Artifact_ AppSpecTemplateInput { get; }
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.
virtual ICodeDeployEcsContainerImageInput[] ContainerImageInputs { get; }
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.
IEcsDeploymentGroup DeploymentGroup { get; }
Property Value
TaskDefinitionTemplateFile
The name of the ECS task definition template file.
virtual ArtifactPath_ TaskDefinitionTemplateFile { get; }
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.
virtual Artifact_ TaskDefinitionTemplateInput { get; }
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