aws-cdk-lib.aws_codepipeline_actions.CodeDeployEcsContainerImageInput

CodeDeployEcsContainerImageInput Struct

Configuration for replacing a placeholder string in the ECS task definition template file with an image URI.

Source

aws-codepipeline-actions/lib/codedeploy/ecs-deploy-action.ts

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codepipeline as codepipeline } from 'aws-cdk-lib';
import { aws_codepipeline_actions as codepipeline_actions } from 'aws-cdk-lib';

declare const artifact: codepipeline.Artifact;
const codeDeployEcsContainerImageInput: codepipeline_actions.CodeDeployEcsContainerImageInput = {
  input: artifact,

  // the properties below are optional
  taskDefinitionPlaceholder: 'taskDefinitionPlaceholder',
};

Properties

inputArtifactinputArtifactinputArtifactInputArtifactInputArtifactrequired#

The artifact that contains an `imageDetails.json` file with the image URI.

The artifact's imageDetails.json file must be a JSON file containing an ImageURI property. For example: { "ImageURI": "ACCOUNTID.dkr.ecr.us-west-2.amazonaws.com/dk-image-repo@sha256:example3" }

taskDefinitionPlaceholder?optionalstringtask_definition_placeholder?optionalstrtaskDefinitionPlaceholder?optionalStringTaskDefinitionPlaceholder?optionalstringTaskDefinitionPlaceholder?optional*string= IMAGE#

The placeholder string in the ECS task definition template file that will be replaced with the image URI.

notes

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 the taskDefinitionPlaceholder value should be PLACEHOLDER.