Interface ActionDeclaration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ActionDeclaration.Builder,ActionDeclaration>, SdkBuilder<ActionDeclaration.Builder,ActionDeclaration>, SdkPojo
Enclosing class:
ActionDeclaration

public static interface ActionDeclaration.Builder extends SdkPojo, CopyableBuilder<ActionDeclaration.Builder,ActionDeclaration>
  • 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

      ActionDeclaration.Builder actionTypeId(ActionTypeId 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

      default ActionDeclaration.Builder actionTypeId(Consumer<ActionTypeId.Builder> actionTypeId)

      Specifies the action type and the provider of the action.

      This is a convenience method that creates an instance of the ActionTypeId.Builder avoiding the need to create one manually via ActionTypeId.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to actionTypeId(ActionTypeId).

      Parameters:
      actionTypeId - a consumer that will call methods on ActionTypeId.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • runOrder

      ActionDeclaration.Builder runOrder(Integer 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

      ActionDeclaration.Builder configuration(Map<String,String> 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

      ActionDeclaration.Builder outputArtifacts(Collection<OutputArtifact> 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

      ActionDeclaration.Builder outputArtifacts(OutputArtifact... 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

      ActionDeclaration.Builder outputArtifacts(Consumer<OutputArtifact.Builder>... 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 the OutputArtifact.Builder avoiding the need to create one manually via OutputArtifact.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputArtifacts(List<OutputArtifact>).

      Parameters:
      outputArtifacts - a consumer that will call methods on OutputArtifact.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • inputArtifacts

      ActionDeclaration.Builder inputArtifacts(Collection<InputArtifact> 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

      ActionDeclaration.Builder inputArtifacts(InputArtifact... 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

      ActionDeclaration.Builder inputArtifacts(Consumer<InputArtifact.Builder>... 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 the InputArtifact.Builder avoiding the need to create one manually via InputArtifact.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inputArtifacts(List<InputArtifact>).

      Parameters:
      inputArtifacts - a consumer that will call methods on InputArtifact.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

      ActionDeclaration.Builder namespace(String 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

      ActionDeclaration.Builder timeoutInMinutes(Integer 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.