CodeDeployEcsDeployActionProps
- class aws_cdk.aws_codepipeline_actions.CodeDeployEcsDeployActionProps(*, action_name, run_order=None, variables_namespace=None, role=None, deployment_group, app_spec_template_file=None, app_spec_template_input=None, container_image_inputs=None, task_definition_template_file=None, task_definition_template_input=None)
Bases:
CommonAwsActionProps
Construction properties of the
CodeDeployEcsDeployAction CodeDeploy ECS deploy CodePipeline Action
.- Parameters:
action_name (
str
) – The physical, human-readable name of the Action. Note that Action names must be unique within a single Stage.run_order (
Union
[int
,float
,None
]) – The runOrder property for this Action. RunOrder determines the relative order in which multiple Actions in the same Stage execute. Default: 1variables_namespace (
Optional
[str
]) – The name of the namespace to use for variables emitted by this action. 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 setrole (
Optional
[IRole
]) – 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 yourIAction.bind
method in theActionBindOptions.role
property. Default: a new Role will be generateddeployment_group (
IEcsDeploymentGroup
) – The CodeDeploy ECS Deployment Group to deploy to.app_spec_template_file (
Optional
[ArtifactPath
]) – The name of the CodeDeploy AppSpec file. 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 theappSpecTemplateInput
property. Default: - one of this property, orappSpecTemplateInput
, is requiredapp_spec_template_input (
Optional
[Artifact
]) – The artifact containing the CodeDeploy AppSpec file. 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 theappSpecTemplateFile
property instead. Default: - one of this property, orappSpecTemplateFile
, is requiredcontainer_image_inputs (
Optional
[Sequence
[Union
[CodeDeployEcsContainerImageInput
,Dict
[str
,Any
]]]]) – Configuration for dynamically updated images in the task definition. 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.task_definition_template_file (
Optional
[ArtifactPath
]) – The name of the ECS task definition template file. 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 thetaskDefinitionTemplateInput
property. Default: - one of this property, ortaskDefinitionTemplateInput
, is requiredtask_definition_template_input (
Optional
[Artifact
]) – The artifact containing the ECS task definition template file. 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 thetaskDefinitionTemplateFile
property instead. Default: - one of this property, ortaskDefinitionTemplateFile
, is required
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_codedeploy as codedeploy from aws_cdk import aws_codepipeline as codepipeline from aws_cdk import aws_codepipeline_actions as codepipeline_actions from aws_cdk import aws_iam as iam # artifact: codepipeline.Artifact # artifact_path: codepipeline.ArtifactPath # ecs_deployment_group: codedeploy.EcsDeploymentGroup # role: iam.Role code_deploy_ecs_deploy_action_props = codepipeline_actions.CodeDeployEcsDeployActionProps( action_name="actionName", deployment_group=ecs_deployment_group, # the properties below are optional app_spec_template_file=artifact_path, app_spec_template_input=artifact, container_image_inputs=[codepipeline_actions.CodeDeployEcsContainerImageInput( input=artifact, # the properties below are optional task_definition_placeholder="taskDefinitionPlaceholder" )], role=role, run_order=123, task_definition_template_file=artifact_path, task_definition_template_input=artifact, variables_namespace="variablesNamespace" )
Attributes
- action_name
The physical, human-readable name of the Action.
Note that Action names must be unique within a single Stage.
- app_spec_template_file
The name of the CodeDeploy AppSpec file.
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
- app_spec_template_input
The artifact containing the CodeDeploy AppSpec file.
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
- container_image_inputs
Configuration for dynamically updated images in the task definition.
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.
- deployment_group
The CodeDeploy ECS Deployment Group to deploy to.
- role
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 theActionBindOptions.role
property.- Default:
a new Role will be generated
- run_order
The runOrder property for this Action.
RunOrder determines the relative order in which multiple Actions in the same Stage execute.
- task_definition_template_file
The name of the ECS task definition template file.
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
- task_definition_template_input
The artifact containing the ECS task definition template file.
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
- variables_namespace
The name of the namespace to use for variables emitted by this action.
- 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