software.amazon.awscdk.services.codepipeline.actions

Class CodeDeployEcsDeployActionProps.Builder

java.lang.Object

software.amazon.awscdk.services.codepipeline.actions.CodeDeployEcsDeployActionProps.Builder

Enclosing interface:

CodeDeployEcsDeployActionProps

@Stability(value=Stable)
public static final class CodeDeployEcsDeployActionProps.Builder
extends Object

A builder for CodeDeployEcsDeployActionProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CodeDeployEcsDeployActionProps.Builder	actionName(String actionName) Sets the value of ActionName
CodeDeployEcsDeployActionProps.Builder	appSpecTemplateFile(ArtifactPath appSpecTemplateFile) Sets the value of AppSpecTemplateFile
CodeDeployEcsDeployActionProps.Builder	appSpecTemplateInput(Artifact appSpecTemplateInput) Sets the value of AppSpecTemplateInput
CodeDeployEcsDeployActionProps	build() Builds the configured instance.
CodeDeployEcsDeployActionProps.Builder	containerImageInputs(List<CodeDeployEcsContainerImageInput> containerImageInputs) Sets the value of ContainerImageInputs
CodeDeployEcsDeployActionProps.Builder	deploymentGroup(IEcsDeploymentGroup deploymentGroup) Sets the value of DeploymentGroup
CodeDeployEcsDeployActionProps.Builder	role(IRole role) Sets the value of Role
CodeDeployEcsDeployActionProps.Builder	runOrder(Number runOrder) Sets the value of RunOrder
CodeDeployEcsDeployActionProps.Builder	taskDefinitionTemplateFile(ArtifactPath taskDefinitionTemplateFile) Sets the value of TaskDefinitionTemplateFile
CodeDeployEcsDeployActionProps.Builder	taskDefinitionTemplateInput(Artifact taskDefinitionTemplateInput) Sets the value of TaskDefinitionTemplateInput

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

deploymentGroup

@Stability(value=Stable)
public CodeDeployEcsDeployActionProps.Builder deploymentGroup(IEcsDeploymentGroup deploymentGroup)

Sets the value of DeploymentGroup

Parameters:

deploymentGroup - The CodeDeploy ECS Deployment Group to deploy to. This parameter is required.

Returns:

this

appSpecTemplateFile

@Stability(value=Stable)
public CodeDeployEcsDeployActionProps.Builder appSpecTemplateFile(ArtifactPath appSpecTemplateFile)

Sets the value of AppSpecTemplateFile

Parameters:

appSpecTemplateFile - 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.

Returns:

this

appSpecTemplateInput

@Stability(value=Stable)
public CodeDeployEcsDeployActionProps.Builder appSpecTemplateInput(Artifact appSpecTemplateInput)

Sets the value of AppSpecTemplateInput

Parameters:

appSpecTemplateInput - 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.

Returns:

this

containerImageInputs

@Stability(value=Stable)
public CodeDeployEcsDeployActionProps.Builder containerImageInputs(List<CodeDeployEcsContainerImageInput> containerImageInputs)

Sets the value of ContainerImageInputs

Parameters:

containerImageInputs - Configuration for dynamically updated images in the task definition.

Returns:

this

taskDefinitionTemplateFile

@Stability(value=Stable)
public CodeDeployEcsDeployActionProps.Builder taskDefinitionTemplateFile(ArtifactPath taskDefinitionTemplateFile)

Sets the value of TaskDefinitionTemplateFile

Parameters:

taskDefinitionTemplateFile - The name of the ECS task definition template file. During deployment, the task definition template file contents will be registered with ECS.

Returns:

this

taskDefinitionTemplateInput

@Stability(value=Stable)
public CodeDeployEcsDeployActionProps.Builder taskDefinitionTemplateInput(Artifact taskDefinitionTemplateInput)

Sets the value of TaskDefinitionTemplateInput

Parameters:

taskDefinitionTemplateInput - The artifact containing the ECS task definition template file. During deployment, the task definition template file contents will be registered with ECS.

Returns:

this

role

@Stability(value=Stable)
public CodeDeployEcsDeployActionProps.Builder role(IRole role)

Sets the value of Role

Parameters:

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 the ActionBindOptions.role property.

Returns:

this

actionName

@Stability(value=Stable)
public CodeDeployEcsDeployActionProps.Builder actionName(String actionName)

Sets the value of ActionName

Parameters:

actionName - The physical, human-readable name of the Action. Not that Action names must be unique within a single Stage. This parameter is required.

Returns:

this

runOrder

@Stability(value=Stable)
public CodeDeployEcsDeployActionProps.Builder runOrder(Number runOrder)

Sets the value of RunOrder

Parameters:

runOrder - The runOrder property for this Action. RunOrder determines the relative order in which multiple Actions in the same Stage execute.

Returns:

this

build

@Stability(value=Stable)
public CodeDeployEcsDeployActionProps build()

Builds the configured instance.

Returns:

a new instance of CodeDeployEcsDeployActionProps

Throws:

NullPointerException - if any required attribute was not provided