software.amazon.awssdk.services.connect.model

Interface TrafficDistributionGroup.Builder

All Superinterfaces:

Buildable, CopyableBuilder<TrafficDistributionGroup.Builder,TrafficDistributionGroup>, SdkBuilder<TrafficDistributionGroup.Builder,TrafficDistributionGroup>, SdkPojo

Enclosing class:

TrafficDistributionGroup

public static interface TrafficDistributionGroup.Builder
extends SdkPojo, CopyableBuilder<TrafficDistributionGroup.Builder,TrafficDistributionGroup>

Method Summary

Modifier and Type	Method and Description
TrafficDistributionGroup.Builder	arn(String arn) The Amazon Resource Name (ARN) of the traffic distribution group.
TrafficDistributionGroup.Builder	description(String description) The description of the traffic distribution group.
TrafficDistributionGroup.Builder	id(String id) The identifier of the traffic distribution group.
TrafficDistributionGroup.Builder	instanceArn(String instanceArn) The Amazon Resource Name (ARN).
TrafficDistributionGroup.Builder	isDefault(Boolean isDefault) Whether this is the default traffic distribution group created during instance replication.
TrafficDistributionGroup.Builder	name(String name) The name of the traffic distribution group.
TrafficDistributionGroup.Builder	status(String status) The status of the traffic distribution group.
TrafficDistributionGroup.Builder	status(TrafficDistributionGroupStatus status) The status of the traffic distribution group.
TrafficDistributionGroup.Builder	tags(Map<String,String> tags) The tags used to organize, track, or control access for this resource.

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

id

TrafficDistributionGroup.Builder id(String id)

The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

Parameters:

id - The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

Returns:

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

arn

TrafficDistributionGroup.Builder arn(String arn)

The Amazon Resource Name (ARN) of the traffic distribution group.

Parameters:

arn - The Amazon Resource Name (ARN) of the traffic distribution group.

Returns:

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

name

TrafficDistributionGroup.Builder name(String name)

The name of the traffic distribution group.

Parameters:

name - The name of the traffic distribution group.

Returns:

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

description

TrafficDistributionGroup.Builder description(String description)

The description of the traffic distribution group.

Parameters:

description - The description of the traffic distribution group.

Returns:

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

instanceArn

TrafficDistributionGroup.Builder instanceArn(String instanceArn)

The Amazon Resource Name (ARN).

Parameters:

instanceArn - The Amazon Resource Name (ARN).

Returns:

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

status

TrafficDistributionGroup.Builder status(String status)

The status of the traffic distribution group.

• CREATION_IN_PROGRESS means the previous CreateTrafficDistributionGroup operation is still in progress and has not yet completed.

• ACTIVE means the previous CreateTrafficDistributionGroup operation has succeeded.

• CREATION_FAILED indicates that the previous CreateTrafficDistributionGroup operation has failed.

• PENDING_DELETION means the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet completed.

• DELETION_FAILED means the previous DeleteTrafficDistributionGroup operation has failed.

• UPDATE_IN_PROGRESS means the previous UpdateTrafficDistributionGroup operation is still in progress and has not yet completed.

Parameters:

status - The status of the traffic distribution group.

• CREATION_IN_PROGRESS means the previous CreateTrafficDistributionGroup operation is still in progress and has not yet completed.

• ACTIVE means the previous CreateTrafficDistributionGroup operation has succeeded.

• CREATION_FAILED indicates that the previous CreateTrafficDistributionGroup operation has failed.

• PENDING_DELETION means the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet completed.

• DELETION_FAILED means the previous DeleteTrafficDistributionGroup operation has failed.

• UPDATE_IN_PROGRESS means the previous UpdateTrafficDistributionGroup operation is still in progress and has not yet completed.

Returns:

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

See Also:

TrafficDistributionGroupStatus, TrafficDistributionGroupStatus

status

TrafficDistributionGroup.Builder status(TrafficDistributionGroupStatus status)

The status of the traffic distribution group.

• CREATION_IN_PROGRESS means the previous CreateTrafficDistributionGroup operation is still in progress and has not yet completed.

• ACTIVE means the previous CreateTrafficDistributionGroup operation has succeeded.

• CREATION_FAILED indicates that the previous CreateTrafficDistributionGroup operation has failed.

• PENDING_DELETION means the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet completed.

• DELETION_FAILED means the previous DeleteTrafficDistributionGroup operation has failed.

• UPDATE_IN_PROGRESS means the previous UpdateTrafficDistributionGroup operation is still in progress and has not yet completed.

Parameters:

status - The status of the traffic distribution group.

• CREATION_IN_PROGRESS means the previous CreateTrafficDistributionGroup operation is still in progress and has not yet completed.

• ACTIVE means the previous CreateTrafficDistributionGroup operation has succeeded.

• CREATION_FAILED indicates that the previous CreateTrafficDistributionGroup operation has failed.

• PENDING_DELETION means the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet completed.

• DELETION_FAILED means the previous DeleteTrafficDistributionGroup operation has failed.

• UPDATE_IN_PROGRESS means the previous UpdateTrafficDistributionGroup operation is still in progress and has not yet completed.

Returns:

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

See Also:

TrafficDistributionGroupStatus, TrafficDistributionGroupStatus

tags

TrafficDistributionGroup.Builder tags(Map<String,String> tags)

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

Parameters:

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

Returns:

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

isDefault

TrafficDistributionGroup.Builder isDefault(Boolean isDefault)

Whether this is the default traffic distribution group created during instance replication. The default traffic distribution group cannot be deleted by the DeleteTrafficDistributionGroup API. The default traffic distribution group is deleted as part of the process for deleting a replica.

You can change the SignInConfig distribution only for a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned.

Parameters:

isDefault - Whether this is the default traffic distribution group created during instance replication. The default traffic distribution group cannot be deleted by the DeleteTrafficDistributionGroup API. The default traffic distribution group is deleted as part of the process for deleting a replica.

You can change the SignInConfig distribution only for a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned.

Returns:

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