Package software.amazon.awscdk.services.codepipeline.actions

Interface CodeDeployEcsContainerImageInput

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CodeDeployEcsContainerImageInput.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-24T21:00:27.315Z")
@Stability(Stable)
public interface CodeDeployEcsContainerImageInput
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codepipeline.*;
 import software.amazon.awscdk.services.codepipeline.actions.*;
 Artifact artifact;
 CodeDeployEcsContainerImageInput codeDeployEcsContainerImageInput = CodeDeployEcsContainerImageInput.builder()
         .input(artifact)
         // the properties below are optional
         .taskDefinitionPlaceholder("taskDefinitionPlaceholder")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CodeDeployEcsContainerImageInput.Builder	A builder for CodeDeployEcsContainerImageInput
static final class	CodeDeployEcsContainerImageInput.Jsii$Proxy	An implementation for CodeDeployEcsContainerImageInput

Method Summary

Modifier and Type	Method	Description
static CodeDeployEcsContainerImageInput.Builder	builder()
Artifact	getInput()	The artifact that contains an imageDetails.json file with the image URI.
default String	getTaskDefinitionPlaceholder()	The placeholder string in the ECS task definition template file that will be replaced with the image URI.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInput

@Stability(Stable)
@NotNull
Artifact getInput()

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" }

getTaskDefinitionPlaceholder

@Stability(Stable)
@Nullable
default String getTaskDefinitionPlaceholder()

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

Default: IMAGE

builder

@Stability(Stable)
static CodeDeployEcsContainerImageInput.Builder builder()

Returns:

a CodeDeployEcsContainerImageInput.Builder of CodeDeployEcsContainerImageInput