public class TrafficDistributionGroup
extends java.lang.Object
implements java.io.Serializable
Information about a traffic distribution group.
| Constructor and Description |
|---|
TrafficDistributionGroup() |
| Modifier and Type | Method and Description |
|---|---|
TrafficDistributionGroup |
addTagsEntry(java.lang.String key,
java.lang.String value)
The tags used to organize, track, or control access for this resource.
|
TrafficDistributionGroup |
clearTagsEntries()
Removes all the entries added into Tags.
|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getArn()
The Amazon Resource Name (ARN) of the traffic distribution group.
|
java.lang.String |
getDescription()
The description of the traffic distribution group.
|
java.lang.String |
getId()
The identifier of the traffic distribution group.
|
java.lang.String |
getInstanceArn()
The Amazon Resource Name (ARN).
|
java.lang.Boolean |
getIsDefault()
Whether this is the default traffic distribution group created during
instance replication.
|
java.lang.String |
getName()
The name of the traffic distribution group.
|
java.lang.String |
getStatus()
The status of the traffic distribution group.
|
java.util.Map<java.lang.String,java.lang.String> |
getTags()
The tags used to organize, track, or control access for this resource.
|
int |
hashCode() |
java.lang.Boolean |
isIsDefault()
Whether this is the default traffic distribution group created during
instance replication.
|
void |
setArn(java.lang.String arn)
The Amazon Resource Name (ARN) of the traffic distribution group.
|
void |
setDescription(java.lang.String description)
The description of the traffic distribution group.
|
void |
setId(java.lang.String id)
The identifier of the traffic distribution group.
|
void |
setInstanceArn(java.lang.String instanceArn)
The Amazon Resource Name (ARN).
|
void |
setIsDefault(java.lang.Boolean isDefault)
Whether this is the default traffic distribution group created during
instance replication.
|
void |
setName(java.lang.String name)
The name of the traffic distribution group.
|
void |
setStatus(java.lang.String status)
The status of the traffic distribution group.
|
void |
setStatus(TrafficDistributionGroupStatus status)
The status of the traffic distribution group.
|
void |
setTags(java.util.Map<java.lang.String,java.lang.String> tags)
The tags used to organize, track, or control access for this resource.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
TrafficDistributionGroup |
withArn(java.lang.String arn)
The Amazon Resource Name (ARN) of the traffic distribution group.
|
TrafficDistributionGroup |
withDescription(java.lang.String description)
The description of the traffic distribution group.
|
TrafficDistributionGroup |
withId(java.lang.String id)
The identifier of the traffic distribution group.
|
TrafficDistributionGroup |
withInstanceArn(java.lang.String instanceArn)
The Amazon Resource Name (ARN).
|
TrafficDistributionGroup |
withIsDefault(java.lang.Boolean isDefault)
Whether this is the default traffic distribution group created during
instance replication.
|
TrafficDistributionGroup |
withName(java.lang.String name)
The name of the traffic distribution group.
|
TrafficDistributionGroup |
withStatus(java.lang.String status)
The status of the traffic distribution group.
|
TrafficDistributionGroup |
withStatus(TrafficDistributionGroupStatus status)
The status of the traffic distribution group.
|
TrafficDistributionGroup |
withTags(java.util.Map<java.lang.String,java.lang.String> tags)
The tags used to organize, track, or control access for this resource.
|
public java.lang.String getId()
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.
Constraints:
Pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
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.
public void setId(java.lang.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.
Constraints:
Pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
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.
public TrafficDistributionGroup withId(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
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.
public java.lang.String getArn()
The Amazon Resource Name (ARN) of the traffic distribution group.
Constraints:
Pattern:
^arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-
9]{1,20}:traffic
-distribution-group/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a
-f0-9]{4}-[a-f0-9]{12}$
The Amazon Resource Name (ARN) of the traffic distribution group.
public void setArn(java.lang.String arn)
The Amazon Resource Name (ARN) of the traffic distribution group.
Constraints:
Pattern:
^arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-
9]{1,20}:traffic
-distribution-group/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a
-f0-9]{4}-[a-f0-9]{12}$
arn - The Amazon Resource Name (ARN) of the traffic distribution group.
public TrafficDistributionGroup withArn(java.lang.String arn)
The Amazon Resource Name (ARN) of the traffic distribution group.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Pattern:
^arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-
9]{1,20}:traffic
-distribution-group/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a
-f0-9]{4}-[a-f0-9]{12}$
arn - The Amazon Resource Name (ARN) of the traffic distribution group.
public java.lang.String getName()
The name of the traffic distribution group.
Constraints:
Length: 1 - 128
Pattern: (^[\S].*[\S]$)|(^[\S]$)
The name of the traffic distribution group.
public void setName(java.lang.String name)
The name of the traffic distribution group.
Constraints:
Length: 1 - 128
Pattern: (^[\S].*[\S]$)|(^[\S]$)
name - The name of the traffic distribution group.
public TrafficDistributionGroup withName(java.lang.String name)
The name of the traffic distribution group.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
Pattern: (^[\S].*[\S]$)|(^[\S]$)
name - The name of the traffic distribution group.
public java.lang.String getDescription()
The description of the traffic distribution group.
Constraints:
Length: 1 - 250
Pattern: (^[\S].*[\S]$)|(^[\S]$)
The description of the traffic distribution group.
public void setDescription(java.lang.String description)
The description of the traffic distribution group.
Constraints:
Length: 1 - 250
Pattern: (^[\S].*[\S]$)|(^[\S]$)
description - The description of the traffic distribution group.
public TrafficDistributionGroup withDescription(java.lang.String description)
The description of the traffic distribution group.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 250
Pattern: (^[\S].*[\S]$)|(^[\S]$)
description - The description of the traffic distribution group.
public java.lang.String getInstanceArn()
The Amazon Resource Name (ARN).
Constraints:
Pattern:
arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9-]{1}:[0-
9]{1,20}:instance
/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}
The Amazon Resource Name (ARN).
public void setInstanceArn(java.lang.String instanceArn)
The Amazon Resource Name (ARN).
Constraints:
Pattern:
arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9-]{1}:[0-
9]{1,20}:instance
/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}
instanceArn - The Amazon Resource Name (ARN).
public TrafficDistributionGroup withInstanceArn(java.lang.String instanceArn)
The Amazon Resource Name (ARN).
Returns a reference to this object so that method calls can be chained together.
Constraints:
Pattern:
arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9-]{1}:[0-
9]{1,20}:instance
/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}
instanceArn - The Amazon Resource Name (ARN).
public java.lang.String getStatus()
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.
Constraints:
Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED,
PENDING_DELETION, DELETION_FAILED, UPDATE_IN_PROGRESS
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.
TrafficDistributionGroupStatuspublic void setStatus(java.lang.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.
Constraints:
Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED,
PENDING_DELETION, DELETION_FAILED, UPDATE_IN_PROGRESS
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.
TrafficDistributionGroupStatuspublic TrafficDistributionGroup withStatus(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED,
PENDING_DELETION, DELETION_FAILED, UPDATE_IN_PROGRESS
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.
TrafficDistributionGroupStatuspublic void setStatus(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.
Constraints:
Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED,
PENDING_DELETION, DELETION_FAILED, UPDATE_IN_PROGRESS
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.
TrafficDistributionGroupStatuspublic TrafficDistributionGroup withStatus(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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED,
PENDING_DELETION, DELETION_FAILED, UPDATE_IN_PROGRESS
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.
TrafficDistributionGroupStatuspublic java.util.Map<java.lang.String,java.lang.String> getTags()
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
public void setTags(java.util.Map<java.lang.String,java.lang.String> tags)
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
tags - The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
public TrafficDistributionGroup withTags(java.util.Map<java.lang.String,java.lang.String> tags)
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
Returns a reference to this object so that method calls can be chained together.
tags - The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
public TrafficDistributionGroup addTagsEntry(java.lang.String key, java.lang.String value)
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
The method adds a new key-value pair into Tags parameter, and returns a reference to this object so that method calls can be chained together.
key - The key of the entry to be added into Tags.value - The corresponding value of the entry to be added into Tags.public TrafficDistributionGroup clearTagsEntries()
Returns a reference to this object so that method calls can be chained together.
public java.lang.Boolean isIsDefault()
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 only for a default
TrafficDistributionGroup. If you call
UpdateTrafficDistribution with a modified
SignInConfig and a non-default
TrafficDistributionGroup, an
InvalidRequestException is returned.
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 only for a default
TrafficDistributionGroup. If you call
UpdateTrafficDistribution with a modified
SignInConfig and a non-default
TrafficDistributionGroup, an
InvalidRequestException is returned.
public java.lang.Boolean getIsDefault()
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 only for a default
TrafficDistributionGroup. If you call
UpdateTrafficDistribution with a modified
SignInConfig and a non-default
TrafficDistributionGroup, an
InvalidRequestException is returned.
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 only for a default
TrafficDistributionGroup. If you call
UpdateTrafficDistribution with a modified
SignInConfig and a non-default
TrafficDistributionGroup, an
InvalidRequestException is returned.
public void setIsDefault(java.lang.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 only for a default
TrafficDistributionGroup. If you call
UpdateTrafficDistribution with a modified
SignInConfig and a non-default
TrafficDistributionGroup, an
InvalidRequestException is returned.
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 only for a
default TrafficDistributionGroup. If you call
UpdateTrafficDistribution with a modified
SignInConfig and a non-default
TrafficDistributionGroup, an
InvalidRequestException is returned.
public TrafficDistributionGroup withIsDefault(java.lang.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 only for a default
TrafficDistributionGroup. If you call
UpdateTrafficDistribution with a modified
SignInConfig and a non-default
TrafficDistributionGroup, an
InvalidRequestException is returned.
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
DeleteTrafficDistributionGroup API. The default
traffic distribution group is deleted as part of the process
for deleting a replica.
You can change the SignInConfig only for a
default TrafficDistributionGroup. If you call
UpdateTrafficDistribution with a modified
SignInConfig and a non-default
TrafficDistributionGroup, an
InvalidRequestException is returned.
public java.lang.String toString()
toString in class java.lang.ObjectObject.toString()public int hashCode()
hashCode in class java.lang.Objectpublic boolean equals(java.lang.Object obj)
equals in class java.lang.Object