Struct aws_sdk_connect::types::TrafficDistributionGroup

#[non_exhaustive]
pub struct TrafficDistributionGroup {
    pub id: Option<String>,
    pub arn: Option<String>,
    pub name: Option<String>,
    pub description: Option<String>,
    pub instance_arn: Option<String>,
    pub status: Option<TrafficDistributionGroupStatus>,
    pub tags: Option<HashMap<String, String>>,
    pub is_default: bool,
}

Information about a traffic distribution group.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: Option<String>

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.

arn: Option<String>

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

name: Option<String>

The name of the traffic distribution group.

description: Option<String>

The description of the traffic distribution group.

instance_arn: Option<String>

The Amazon Resource Name (ARN).

status: Option<TrafficDistributionGroupStatus>

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 UpdateTrafficDistribution operation is still in progress and has not yet completed.

tags: Option<HashMap<String, String>>

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

is_default: bool

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.

The SignInConfig distribution is available only on 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.

Implementations

impl TrafficDistributionGroup

pub fn id(&self) -> Option<&str>

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.

pub fn arn(&self) -> Option<&str>

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

pub fn name(&self) -> Option<&str>

The name of the traffic distribution group.

pub fn description(&self) -> Option<&str>

The description of the traffic distribution group.

pub fn instance_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN).

pub fn status(&self) -> Option<&TrafficDistributionGroupStatus>

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 UpdateTrafficDistribution operation is still in progress and has not yet completed.

pub fn tags(&self) -> Option<&HashMap<String, String>>

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

pub fn is_default(&self) -> bool

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.

The SignInConfig distribution is available only on 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.

impl TrafficDistributionGroup

pub fn builder() -> TrafficDistributionGroupBuilder

Creates a new builder-style object to manufacture TrafficDistributionGroup.

Trait Implementations

impl Clone for TrafficDistributionGroup

fn clone(&self) -> TrafficDistributionGroup

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TrafficDistributionGroup

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for TrafficDistributionGroup

fn eq(&self, other: &TrafficDistributionGroup) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TrafficDistributionGroup