@Stability(value=Experimental) public static final class EcsDeployActionProps.Builder extends Object implements software.amazon.jsii.Builder<EcsDeployActionProps>
EcsDeployActionProps
Constructor and Description |
---|
Builder() |
@Stability(value=Experimental) public EcsDeployActionProps.Builder service(IBaseService service)
EcsDeployActionProps.getService()
service
- The ECS Service to deploy. This parameter is required.this
@Stability(value=Experimental) public EcsDeployActionProps.Builder deploymentTimeout(Duration deploymentTimeout)
EcsDeployActionProps.getDeploymentTimeout()
deploymentTimeout
- Timeout for the ECS deployment in minutes.
Value must be between 1-60.this
@Stability(value=Experimental) public EcsDeployActionProps.Builder imageFile(ArtifactPath imageFile)
EcsDeployActionProps.getImageFile()
imageFile
- The name of the JSON image definitions file to use for deployments.
The JSON file is a list of objects,
each with 2 keys: name
is the name of the container in the Task Definition,
and imageUri
is the Docker image URI you want to update your service with.
Use this property if you want to use a different name for this file than the default 'imagedefinitions.json'.
If you use this property, you don't need to specify the input
property.this
@Stability(value=Experimental) public EcsDeployActionProps.Builder input(Artifact input)
EcsDeployActionProps.getInput()
input
- The input artifact that contains the JSON image definitions file to use for deployments.
The JSON file is a list of objects,
each with 2 keys: name
is the name of the container in the Task Definition,
and imageUri
is the Docker image URI you want to update your service with.
If you use this property, it's assumed the file is called 'imagedefinitions.json'.
If your build uses a different file, leave this property empty,
and use the imageFile
property instead.this
@Stability(value=Experimental) public EcsDeployActionProps.Builder role(IRole role)
CommonAwsActionProps.getRole()
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 {@link IAction.bind}
method in the {@link ActionBindOptions.role} property.this
@Stability(value=Experimental) public EcsDeployActionProps.Builder actionName(String actionName)
CommonActionProps.getActionName()
actionName
- The physical, human-readable name of the Action. This parameter is required.
Note that Action names must be unique within a single Stage.this
@Stability(value=Experimental) public EcsDeployActionProps.Builder runOrder(Number runOrder)
CommonActionProps.getRunOrder()
runOrder
- The runOrder property for this Action.
RunOrder determines the relative order in which multiple Actions in the same Stage execute.this
@Stability(value=Experimental) public EcsDeployActionProps.Builder variablesNamespace(String variablesNamespace)
CommonActionProps.getVariablesNamespace()
variablesNamespace
- The name of the namespace to use for variables emitted by this action.this
@Stability(value=Experimental) public EcsDeployActionProps build()
build
in interface software.amazon.jsii.Builder<EcsDeployActionProps>
EcsDeployActionProps
NullPointerException
- if any required attribute was not providedCopyright © 2021. All rights reserved.