Interface ActionDeclaration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ActionDeclaration.Builder,
,ActionDeclaration> SdkBuilder<ActionDeclaration.Builder,
,ActionDeclaration> SdkPojo
- Enclosing class:
ActionDeclaration
-
Method Summary
Modifier and TypeMethodDescriptiondefault ActionDeclaration.Builder
actionTypeId
(Consumer<ActionTypeId.Builder> actionTypeId) Specifies the action type and the provider of the action.actionTypeId
(ActionTypeId actionTypeId) Specifies the action type and the provider of the action.configuration
(Map<String, String> configuration) The action's configuration.inputArtifacts
(Collection<InputArtifact> inputArtifacts) The name or ID of the artifact consumed by the action, such as a test or build artifact.inputArtifacts
(Consumer<InputArtifact.Builder>... inputArtifacts) The name or ID of the artifact consumed by the action, such as a test or build artifact.inputArtifacts
(InputArtifact... inputArtifacts) The name or ID of the artifact consumed by the action, such as a test or build artifact.The action declaration's name.The variable namespace associated with the action.outputArtifacts
(Collection<OutputArtifact> outputArtifacts) The name or ID of the result of the action declaration, such as a test or build artifact.outputArtifacts
(Consumer<OutputArtifact.Builder>... outputArtifacts) The name or ID of the result of the action declaration, such as a test or build artifact.outputArtifacts
(OutputArtifact... outputArtifacts) The name or ID of the result of the action declaration, such as a test or build artifact.The action declaration's Amazon Web Services Region, such as us-east-1.The ARN of the IAM service role that performs the declared action.The order in which actions are run.timeoutInMinutes
(Integer timeoutInMinutes) A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in Quotas for CodePipeline .Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
name
The action declaration's name.
- Parameters:
name
- The action declaration's name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
actionTypeId
Specifies the action type and the provider of the action.
- Parameters:
actionTypeId
- Specifies the action type and the provider of the action.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
actionTypeId
Specifies the action type and the provider of the action.
This is a convenience method that creates an instance of theActionTypeId.Builder
avoiding the need to create one manually viaActionTypeId.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toactionTypeId(ActionTypeId)
.- Parameters:
actionTypeId
- a consumer that will call methods onActionTypeId.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
runOrder
The order in which actions are run.
- Parameters:
runOrder
- The order in which actions are run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
configuration
The action's configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the CloudFormation action type in CodePipeline, see Configuration Properties Reference in the CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the CloudFormation User Guide.
The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:
JSON:
"Configuration" : { Key : Value },
- Parameters:
configuration
- The action's configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the CloudFormation action type in CodePipeline, see Configuration Properties Reference in the CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the CloudFormation User Guide.The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:
JSON:
"Configuration" : { Key : Value },
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputArtifacts
The name or ID of the result of the action declaration, such as a test or build artifact.
- Parameters:
outputArtifacts
- The name or ID of the result of the action declaration, such as a test or build artifact.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputArtifacts
The name or ID of the result of the action declaration, such as a test or build artifact.
- Parameters:
outputArtifacts
- The name or ID of the result of the action declaration, such as a test or build artifact.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputArtifacts
The name or ID of the result of the action declaration, such as a test or build artifact.
This is a convenience method that creates an instance of theOutputArtifact.Builder
avoiding the need to create one manually viaOutputArtifact.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooutputArtifacts(List<OutputArtifact>)
.- Parameters:
outputArtifacts
- a consumer that will call methods onOutputArtifact.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
inputArtifacts
The name or ID of the artifact consumed by the action, such as a test or build artifact.
- Parameters:
inputArtifacts
- The name or ID of the artifact consumed by the action, such as a test or build artifact.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inputArtifacts
The name or ID of the artifact consumed by the action, such as a test or build artifact.
- Parameters:
inputArtifacts
- The name or ID of the artifact consumed by the action, such as a test or build artifact.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inputArtifacts
The name or ID of the artifact consumed by the action, such as a test or build artifact.
This is a convenience method that creates an instance of theInputArtifact.Builder
avoiding the need to create one manually viaInputArtifact.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinputArtifacts(List<InputArtifact>)
.- Parameters:
inputArtifacts
- a consumer that will call methods onInputArtifact.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
roleArn
The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
- Parameters:
roleArn
- The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
region
The action declaration's Amazon Web Services Region, such as us-east-1.
- Parameters:
region
- The action declaration's Amazon Web Services Region, such as us-east-1.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
namespace
The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
- Parameters:
namespace
- The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
timeoutInMinutes
A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in Quotas for CodePipeline . This attribute is available only to the manual approval ActionType.
- Parameters:
timeoutInMinutes
- A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in Quotas for CodePipeline . This attribute is available only to the manual approval ActionType.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-