Class CodeDeployEcsDeployActionProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CodeDeployEcsDeployActionProps>
- Enclosing interface:
CodeDeployEcsDeployActionProps
CodeDeployEcsDeployActionProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionactionName
(String actionName) Sets the value ofCommonActionProps.getActionName()
appSpecTemplateFile
(ArtifactPath appSpecTemplateFile) Sets the value ofCodeDeployEcsDeployActionProps.getAppSpecTemplateFile()
appSpecTemplateInput
(Artifact appSpecTemplateInput) Sets the value ofCodeDeployEcsDeployActionProps.getAppSpecTemplateInput()
build()
Builds the configured instance.containerImageInputs
(List<? extends CodeDeployEcsContainerImageInput> containerImageInputs) Sets the value ofCodeDeployEcsDeployActionProps.getContainerImageInputs()
deploymentGroup
(IEcsDeploymentGroup deploymentGroup) Sets the value ofCodeDeployEcsDeployActionProps.getDeploymentGroup()
Sets the value ofCommonAwsActionProps.getRole()
Sets the value ofCommonActionProps.getRunOrder()
taskDefinitionTemplateFile
(ArtifactPath taskDefinitionTemplateFile) Sets the value ofCodeDeployEcsDeployActionProps.getTaskDefinitionTemplateFile()
taskDefinitionTemplateInput
(Artifact taskDefinitionTemplateInput) Sets the value ofCodeDeployEcsDeployActionProps.getTaskDefinitionTemplateInput()
variablesNamespace
(String variablesNamespace) Sets the value ofCommonActionProps.getVariablesNamespace()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
deploymentGroup
@Stability(Stable) public CodeDeployEcsDeployActionProps.Builder deploymentGroup(IEcsDeploymentGroup deploymentGroup) Sets the value ofCodeDeployEcsDeployActionProps.getDeploymentGroup()
- Parameters:
deploymentGroup
- The CodeDeploy ECS Deployment Group to deploy to. This parameter is required.- Returns:
this
-
appSpecTemplateFile
@Stability(Stable) public CodeDeployEcsDeployActionProps.Builder appSpecTemplateFile(ArtifactPath appSpecTemplateFile) Sets the value ofCodeDeployEcsDeployActionProps.getAppSpecTemplateFile()
- 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.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.- Returns:
this
-
appSpecTemplateInput
@Stability(Stable) public CodeDeployEcsDeployActionProps.Builder appSpecTemplateInput(Artifact appSpecTemplateInput) Sets the value ofCodeDeployEcsDeployActionProps.getAppSpecTemplateInput()
- 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.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.- Returns:
this
-
containerImageInputs
@Stability(Stable) public CodeDeployEcsDeployActionProps.Builder containerImageInputs(List<? extends CodeDeployEcsContainerImageInput> containerImageInputs) Sets the value ofCodeDeployEcsDeployActionProps.getContainerImageInputs()
- Parameters:
containerImageInputs
- 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.- Returns:
this
-
taskDefinitionTemplateFile
@Stability(Stable) public CodeDeployEcsDeployActionProps.Builder taskDefinitionTemplateFile(ArtifactPath taskDefinitionTemplateFile) Sets the value ofCodeDeployEcsDeployActionProps.getTaskDefinitionTemplateFile()
- Parameters:
taskDefinitionTemplateFile
- 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.- Returns:
this
-
taskDefinitionTemplateInput
@Stability(Stable) public CodeDeployEcsDeployActionProps.Builder taskDefinitionTemplateInput(Artifact taskDefinitionTemplateInput) Sets the value ofCodeDeployEcsDeployActionProps.getTaskDefinitionTemplateInput()
- Parameters:
taskDefinitionTemplateInput
- 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.- Returns:
this
-
role
Sets the value ofCommonAwsActionProps.getRole()
- 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 yourIAction.bind
method in theActionBindOptions.role
property.- Returns:
this
-
actionName
Sets the value ofCommonActionProps.getActionName()
- Parameters:
actionName
- The physical, human-readable name of the Action. This parameter is required. Note that Action names must be unique within a single Stage.- Returns:
this
-
runOrder
Sets the value ofCommonActionProps.getRunOrder()
- Parameters:
runOrder
- The runOrder property for this Action. RunOrder determines the relative order in which multiple Actions in the same Stage execute.- Returns:
this
-
variablesNamespace
@Stability(Stable) public CodeDeployEcsDeployActionProps.Builder variablesNamespace(String variablesNamespace) Sets the value ofCommonActionProps.getVariablesNamespace()
- Parameters:
variablesNamespace
- The name of the namespace to use for variables emitted by this action.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CodeDeployEcsDeployActionProps>
- Returns:
- a new instance of
CodeDeployEcsDeployActionProps
- Throws:
NullPointerException
- if any required attribute was not provided
-