software.amazon.awssdk.services.ssm.model

Interface StartChangeRequestExecutionRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<StartChangeRequestExecutionRequest.Builder,StartChangeRequestExecutionRequest>, SdkBuilder<StartChangeRequestExecutionRequest.Builder,StartChangeRequestExecutionRequest>, SdkPojo, SdkRequest.Builder, SsmRequest.Builder

Enclosing class:

StartChangeRequestExecutionRequest

public static interface StartChangeRequestExecutionRequest.Builder
extends SsmRequest.Builder, SdkPojo, CopyableBuilder<StartChangeRequestExecutionRequest.Builder,StartChangeRequestExecutionRequest>

Method Summary

Modifier and Type	Method and Description
StartChangeRequestExecutionRequest.Builder	changeRequestName(String changeRequestName) The name of the change request associated with the runbook workflow to be run.
StartChangeRequestExecutionRequest.Builder	clientToken(String clientToken) The user-provided idempotency token.
StartChangeRequestExecutionRequest.Builder	documentName(String documentName) The name of the change template document to run during the runbook workflow.
StartChangeRequestExecutionRequest.Builder	documentVersion(String documentVersion) The version of the change template document to run during the runbook workflow.
StartChangeRequestExecutionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
StartChangeRequestExecutionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
StartChangeRequestExecutionRequest.Builder	parameters(Map<String,? extends Collection<String>> parameters) A key-value map of parameters that match the declared parameters in the change template document.
StartChangeRequestExecutionRequest.Builder	runbooks(Collection<Runbook> runbooks) Information about the Automation runbooks (Automation documents) that are run during the runbook workflow.
StartChangeRequestExecutionRequest.Builder	runbooks(Consumer<Runbook.Builder>... runbooks) Information about the Automation runbooks (Automation documents) that are run during the runbook workflow.
StartChangeRequestExecutionRequest.Builder	runbooks(Runbook... runbooks) Information about the Automation runbooks (Automation documents) that are run during the runbook workflow.
StartChangeRequestExecutionRequest.Builder	scheduledTime(Instant scheduledTime) The date and time specified in the change request to run the Automation runbooks.
StartChangeRequestExecutionRequest.Builder	tags(Collection<Tag> tags) Optional metadata that you assign to a resource.
StartChangeRequestExecutionRequest.Builder	tags(Consumer<Tag.Builder>... tags) Optional metadata that you assign to a resource.
StartChangeRequestExecutionRequest.Builder	tags(Tag... tags) Optional metadata that you assign to a resource.

Methods inherited from interface software.amazon.awssdk.services.ssm.model.SsmRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

scheduledTime

StartChangeRequestExecutionRequest.Builder scheduledTime(Instant scheduledTime)

The date and time specified in the change request to run the Automation runbooks.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

Parameters:

scheduledTime - The date and time specified in the change request to run the Automation runbooks.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

Returns:

Returns a reference to this object so that method calls can be chained together.

documentName

StartChangeRequestExecutionRequest.Builder documentName(String documentName)

The name of the change template document to run during the runbook workflow.

Parameters:

documentName - The name of the change template document to run during the runbook workflow.

Returns:

Returns a reference to this object so that method calls can be chained together.

documentVersion

StartChangeRequestExecutionRequest.Builder documentVersion(String documentVersion)

The version of the change template document to run during the runbook workflow.

Parameters:

documentVersion - The version of the change template document to run during the runbook workflow.

Returns:

Returns a reference to this object so that method calls can be chained together.

parameters

StartChangeRequestExecutionRequest.Builder parameters(Map<String,? extends Collection<String>> parameters)

A key-value map of parameters that match the declared parameters in the change template document.

Parameters:

parameters - A key-value map of parameters that match the declared parameters in the change template document.

Returns:

Returns a reference to this object so that method calls can be chained together.

changeRequestName

StartChangeRequestExecutionRequest.Builder changeRequestName(String changeRequestName)

The name of the change request associated with the runbook workflow to be run.

Parameters:

changeRequestName - The name of the change request associated with the runbook workflow to be run.

Returns:

Returns a reference to this object so that method calls can be chained together.

clientToken

StartChangeRequestExecutionRequest.Builder clientToken(String clientToken)

The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

Parameters:

clientToken - The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

Returns:

Returns a reference to this object so that method calls can be chained together.

runbooks

StartChangeRequestExecutionRequest.Builder runbooks(Collection<Runbook> runbooks)

Information about the Automation runbooks (Automation documents) that are run during the runbook workflow.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

Parameters:

runbooks - Information about the Automation runbooks (Automation documents) that are run during the runbook workflow.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

Returns:

Returns a reference to this object so that method calls can be chained together.

runbooks

StartChangeRequestExecutionRequest.Builder runbooks(Runbook... runbooks)

Information about the Automation runbooks (Automation documents) that are run during the runbook workflow.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

Parameters:

runbooks - Information about the Automation runbooks (Automation documents) that are run during the runbook workflow.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

Returns:

Returns a reference to this object so that method calls can be chained together.

runbooks

StartChangeRequestExecutionRequest.Builder runbooks(Consumer<Runbook.Builder>... runbooks)

Information about the Automation runbooks (Automation documents) that are run during the runbook workflow.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #runbooks(List).

Parameters:

runbooks - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#runbooks(List)

tags

StartChangeRequestExecutionRequest.Builder tags(Collection<Tag> tags)

Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target AWS Region. In this case, you could specify the following key-value pairs:

• Key=Environment,Value=Production

• Key=Region,Value=us-east-2

Parameters:

tags - Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target AWS Region. In this case, you could specify the following key-value pairs:

• Key=Environment,Value=Production

• Key=Region,Value=us-east-2

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

StartChangeRequestExecutionRequest.Builder tags(Tag... tags)

Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target AWS Region. In this case, you could specify the following key-value pairs:

• Key=Environment,Value=Production

• Key=Region,Value=us-east-2

Parameters:

tags - Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target AWS Region. In this case, you could specify the following key-value pairs:

• Key=Environment,Value=Production

• Key=Region,Value=us-east-2

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

StartChangeRequestExecutionRequest.Builder tags(Consumer<Tag.Builder>... tags)

Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target AWS Region. In this case, you could specify the following key-value pairs:

• Key=Environment,Value=Production

• Key=Region,Value=us-east-2

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(List)

overrideConfiguration

StartChangeRequestExecutionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

StartChangeRequestExecutionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder