software.amazon.awssdk.services.backup.model

Interface CreateBackupPlanRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BackupRequest.Builder, Buildable, CopyableBuilder<CreateBackupPlanRequest.Builder,CreateBackupPlanRequest>, SdkBuilder<CreateBackupPlanRequest.Builder,CreateBackupPlanRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateBackupPlanRequest

public static interface CreateBackupPlanRequest.Builder
extends BackupRequest.Builder, SdkPojo, CopyableBuilder<CreateBackupPlanRequest.Builder,CreateBackupPlanRequest>

Method Summary

Modifier and Type	Method and Description
CreateBackupPlanRequest.Builder	backupPlan(BackupPlanInput backupPlan) Specifies the body of a backup plan.
default CreateBackupPlanRequest.Builder	backupPlan(Consumer<BackupPlanInput.Builder> backupPlan) Specifies the body of a backup plan.
CreateBackupPlanRequest.Builder	backupPlanTags(Map<String,String> backupPlanTags) To help organize your resources, you can assign your own metadata to the resources that you create.
CreateBackupPlanRequest.Builder	creatorRequestId(String creatorRequestId) Identifies the request and allows failed requests to be retried without the risk of running the operation twice.
CreateBackupPlanRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateBackupPlanRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.services.backup.model.BackupRequest.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

backupPlan

CreateBackupPlanRequest.Builder backupPlan(BackupPlanInput backupPlan)

Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

Parameters:

backupPlan - Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

Returns:

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

backupPlan

default CreateBackupPlanRequest.Builder backupPlan(Consumer<BackupPlanInput.Builder> backupPlan)

Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

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

Parameters:

backupPlan - a consumer that will call methods on BackupPlanInput.Builder

Returns:

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

See Also:

backupPlan(BackupPlanInput)

backupPlanTags

CreateBackupPlanRequest.Builder backupPlanTags(Map<String,String> backupPlanTags)

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.

Parameters:

backupPlanTags - To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.

Returns:

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

creatorRequestId

CreateBackupPlanRequest.Builder creatorRequestId(String creatorRequestId)

Identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned. This parameter is optional.

Parameters:

creatorRequestId - Identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned. This parameter is optional.

Returns:

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

overrideConfiguration

CreateBackupPlanRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

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

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.