Interface CreateArchiveRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateArchiveRequest.Builder,CreateArchiveRequest>, MailManagerRequest.Builder, SdkBuilder<CreateArchiveRequest.Builder,CreateArchiveRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateArchiveRequest

@Mutable
@NotThreadSafe
public static interface CreateArchiveRequest.Builder
extends MailManagerRequest.Builder, SdkPojo, CopyableBuilder<CreateArchiveRequest.Builder,CreateArchiveRequest>

Method Summary

Modifier and Type	Method	Description
CreateArchiveRequest.Builder	archiveName(String archiveName)	A unique name for the new archive.
CreateArchiveRequest.Builder	clientToken(String clientToken)	A unique token Amazon SES uses to recognize retries of this request.
CreateArchiveRequest.Builder	kmsKeyArn(String kmsKeyArn)	The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.
CreateArchiveRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateArchiveRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreateArchiveRequest.Builder	retention(Consumer<ArchiveRetention.Builder> retention)	The period for retaining emails in the archive before automatic deletion.
CreateArchiveRequest.Builder	retention(ArchiveRetention retention)	The period for retaining emails in the archive before automatic deletion.
CreateArchiveRequest.Builder	tags(Collection<Tag> tags)	The tags used to organize, track, or control access for the resource.
CreateArchiveRequest.Builder	tags(Consumer<Tag.Builder>... tags)	The tags used to organize, track, or control access for the resource.
CreateArchiveRequest.Builder	tags(Tag... tags)	The tags used to organize, track, or control access for the resource.

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

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.mailmanager.model.MailManagerRequest.Builder

build

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

clientToken

CreateArchiveRequest.Builder clientToken(String clientToken)

A unique token Amazon SES uses to recognize retries of this request.

Parameters:

clientToken - A unique token Amazon SES uses to recognize retries of this request.

Returns:

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

archiveName

CreateArchiveRequest.Builder archiveName(String archiveName)

A unique name for the new archive.

Parameters:

archiveName - A unique name for the new archive.

Returns:

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

retention

CreateArchiveRequest.Builder retention(ArchiveRetention retention)

The period for retaining emails in the archive before automatic deletion.

Parameters:

retention - The period for retaining emails in the archive before automatic deletion.

Returns:

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

retention

default CreateArchiveRequest.Builder retention(Consumer<ArchiveRetention.Builder> retention)

The period for retaining emails in the archive before automatic deletion.

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

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

Parameters:

retention - a consumer that will call methods on ArchiveRetention.Builder

Returns:

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

See Also:

• retention(ArchiveRetention)

kmsKeyArn

CreateArchiveRequest.Builder kmsKeyArn(String kmsKeyArn)

The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.

Parameters:

kmsKeyArn - The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.

Returns:

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

tags

CreateArchiveRequest.Builder tags(Collection<Tag> tags)

The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Parameters:

tags - The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Returns:

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

tags

CreateArchiveRequest.Builder tags(Tag... tags)

The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Parameters:

tags - The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Returns:

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

tags

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

The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

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

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

Parameters:

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

Returns:

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

See Also:

• tags(java.util.Collection<Tag>)

overrideConfiguration

CreateArchiveRequest.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

CreateArchiveRequest.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.