Class EcsDeployAction.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<EcsDeployAction>
- Enclosing class:
EcsDeployAction
EcsDeployAction
.-
Method Summary
Modifier and TypeMethodDescriptionactionName
(String actionName) The physical, human-readable name of the Action.build()
static EcsDeployAction.Builder
create()
deploymentTimeout
(Duration deploymentTimeout) Timeout for the ECS deployment in minutes.imageFile
(ArtifactPath imageFile) The name of the JSON image definitions file to use for deployments.The input artifact that contains the JSON image definitions file to use for deployments.The Role in which context's this Action will be executing in.The runOrder property for this Action.service
(IBaseService service) The ECS Service to deploy.variablesNamespace
(String variablesNamespace) The name of the namespace to use for variables emitted by this action.
-
Method Details
-
create
- Returns:
- a new instance of
EcsDeployAction.Builder
.
-
actionName
The physical, human-readable name of the Action.Note that Action names must be unique within a single Stage.
- Parameters:
actionName
- The physical, human-readable name of the Action. This parameter is required.- Returns:
this
-
runOrder
The runOrder property for this Action.RunOrder determines the relative order in which multiple Actions in the same Stage execute.
Default: 1
- Parameters:
runOrder
- The runOrder property for this Action. This parameter is required.- Returns:
this
- See Also:
-
variablesNamespace
The name of the namespace to use for variables emitted by this action.Default: - a name will be generated, based on the stage and action names, if any of the action's variables were referenced - otherwise, no namespace will be set
- Parameters:
variablesNamespace
- The name of the namespace to use for variables emitted by this action. This parameter is required.- Returns:
this
-
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 theActionBindOptions.role
property.Default: a new Role will be generated
- Parameters:
role
- The Role in which context's this Action will be executing in. This parameter is required.- Returns:
this
-
service
The ECS Service to deploy.- Parameters:
service
- The ECS Service to deploy. This parameter is required.- Returns:
this
-
deploymentTimeout
Timeout for the ECS deployment in minutes.Value must be between 1-60.
Default: - 60 minutes
- Parameters:
deploymentTimeout
- Timeout for the ECS deployment in minutes. This parameter is required.- Returns:
this
- See Also:
-
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, andimageUri
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 theinput
property.Default: - one of this property, or `input`, is required
- Parameters:
imageFile
- The name of the JSON image definitions file to use for deployments. This parameter is required.- Returns:
this
- See Also:
-
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, andimageUri
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 theimageFile
property instead.Default: - one of this property, or `imageFile`, is required
- Parameters:
input
- The input artifact that contains the JSON image definitions file to use for deployments. This parameter is required.- Returns:
this
- See Also:
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<EcsDeployAction>
- Returns:
- a newly built instance of
EcsDeployAction
.
-