Interface TrafficDistributionGroup.Builder
- All Superinterfaces:
Buildable,CopyableBuilder<TrafficDistributionGroup.Builder,,TrafficDistributionGroup> SdkBuilder<TrafficDistributionGroup.Builder,,TrafficDistributionGroup> SdkPojo
- Enclosing class:
TrafficDistributionGroup
-
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the traffic distribution group.description(String description) The description of the traffic distribution group.The identifier of the traffic distribution group.instanceArn(String instanceArn) The Amazon Resource Name (ARN).Whether this is the default traffic distribution group created during instance replication.The name of the traffic distribution group.The status of the traffic distribution group.status(TrafficDistributionGroupStatus status) The status of the traffic distribution group.The tags used to organize, track, or control access for this resource.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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
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
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
The status of the traffic distribution group.
-
CREATION_IN_PROGRESSmeans the previous CreateTrafficDistributionGroup operation is still in progress and has not yet completed. -
ACTIVEmeans the previous CreateTrafficDistributionGroup operation has succeeded. -
CREATION_FAILEDindicates that the previous CreateTrafficDistributionGroup operation has failed. -
PENDING_DELETIONmeans the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet completed. -
DELETION_FAILEDmeans the previous DeleteTrafficDistributionGroup operation has failed. -
UPDATE_IN_PROGRESSmeans the previous UpdateTrafficDistribution operation is still in progress and has not yet completed.
- Parameters:
status- The status of the traffic distribution group.-
CREATION_IN_PROGRESSmeans the previous CreateTrafficDistributionGroup operation is still in progress and has not yet completed. -
ACTIVEmeans the previous CreateTrafficDistributionGroup operation has succeeded. -
CREATION_FAILEDindicates that the previous CreateTrafficDistributionGroup operation has failed. -
PENDING_DELETIONmeans the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet completed. -
DELETION_FAILEDmeans the previous DeleteTrafficDistributionGroup operation has failed. -
UPDATE_IN_PROGRESSmeans the previous UpdateTrafficDistribution 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:
-
-
status
The status of the traffic distribution group.
-
CREATION_IN_PROGRESSmeans the previous CreateTrafficDistributionGroup operation is still in progress and has not yet completed. -
ACTIVEmeans the previous CreateTrafficDistributionGroup operation has succeeded. -
CREATION_FAILEDindicates that the previous CreateTrafficDistributionGroup operation has failed. -
PENDING_DELETIONmeans the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet completed. -
DELETION_FAILEDmeans the previous DeleteTrafficDistributionGroup operation has failed. -
UPDATE_IN_PROGRESSmeans the previous UpdateTrafficDistribution operation is still in progress and has not yet completed.
- Parameters:
status- The status of the traffic distribution group.-
CREATION_IN_PROGRESSmeans the previous CreateTrafficDistributionGroup operation is still in progress and has not yet completed. -
ACTIVEmeans the previous CreateTrafficDistributionGroup operation has succeeded. -
CREATION_FAILEDindicates that the previous CreateTrafficDistributionGroup operation has failed. -
PENDING_DELETIONmeans the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet completed. -
DELETION_FAILEDmeans the previous DeleteTrafficDistributionGroup operation has failed. -
UPDATE_IN_PROGRESSmeans the previous UpdateTrafficDistribution 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:
-
-
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
Whether this is the default traffic distribution group created during instance replication. The default traffic distribution group cannot be deleted by the
DeleteTrafficDistributionGroupAPI. The default traffic distribution group is deleted as part of the process for deleting a replica.The
SignInConfigdistribution is available only on a defaultTrafficDistributionGroup(see theIsDefaultparameter in the TrafficDistributionGroup data type). If you callUpdateTrafficDistributionwith a modifiedSignInConfigand a non-defaultTrafficDistributionGroup, anInvalidRequestExceptionis returned.- Parameters:
isDefault- Whether this is the default traffic distribution group created during instance replication. The default traffic distribution group cannot be deleted by theDeleteTrafficDistributionGroupAPI. The default traffic distribution group is deleted as part of the process for deleting a replica.The
SignInConfigdistribution is available only on a defaultTrafficDistributionGroup(see theIsDefaultparameter in the TrafficDistributionGroup data type). If you callUpdateTrafficDistributionwith a modifiedSignInConfigand a non-defaultTrafficDistributionGroup, anInvalidRequestExceptionis returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-