CodeDeployEcsContainerImageInput
- class aws_cdk.aws_codepipeline_actions.CodeDeployEcsContainerImageInput(*, input, task_definition_placeholder=None)
Bases:
object
Configuration for replacing a placeholder string in the ECS task definition template file with an image URI.
- Parameters:
input (
Artifact
) – The artifact that contains animageDetails.json
file with the image URI. The artifact’simageDetails.json
file must be a JSON file containing anImageURI
property. For example:{ "ImageURI": "ACCOUNTID.dkr.ecr.us-west-2.amazonaws.com/dk-image-repo@sha256:example3" }
task_definition_placeholder (
Optional
[str
]) – The placeholder string in the ECS task definition template file that will be replaced with the image URI. The placeholder string must be surrounded by angle brackets in the template file. For example, if the task definition template file contains a placeholder like"image": "<PLACEHOLDER>"
, then thetaskDefinitionPlaceholder
value should bePLACEHOLDER
. Default: IMAGE
- 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_codepipeline as codepipeline from aws_cdk import aws_codepipeline_actions as codepipeline_actions # artifact: codepipeline.Artifact code_deploy_ecs_container_image_input = codepipeline_actions.CodeDeployEcsContainerImageInput( input=artifact, # the properties below are optional task_definition_placeholder="taskDefinitionPlaceholder" )
Attributes
- input
The artifact that contains an
imageDetails.json
file with the image URI.The artifact’s
imageDetails.json
file must be a JSON file containing anImageURI
property. For example:{ "ImageURI": "ACCOUNTID.dkr.ecr.us-west-2.amazonaws.com/dk-image-repo@sha256:example3" }
- task_definition_placeholder
The placeholder string in the ECS task definition template file that will be replaced with the image URI.
The placeholder string must be surrounded by angle brackets in the template file. For example, if the task definition template file contains a placeholder like
"image": "<PLACEHOLDER>"
, then thetaskDefinitionPlaceholder
value should bePLACEHOLDER
.- Default:
IMAGE