AWSConnectTrafficDistributionGroup Class Reference

arn

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

Declaration

Objective-C

@property (nonatomic, strong) NSString *_Nullable arn;

Swift

var arn: String? { get set }


                    
                    
                    detail

The description of the traffic distribution group.

Declaration

Objective-C

@property (nonatomic, strong) NSString *_Nullable detail;

Swift

var detail: String? { get set }


                    
                    
                    identifier

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.

Declaration

Objective-C

@property (nonatomic, strong) NSString *_Nullable identifier;

Swift

var identifier: String? { get set }


                    
                    
                    instanceArn

The Amazon Resource Name (ARN).

Declaration

Objective-C

@property (nonatomic, strong) NSString *_Nullable instanceArn;

Swift

var instanceArn: String? { get set }


                    
                    
                    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.

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.

Declaration

Objective-C

@property (nonatomic, strong) NSNumber *_Nullable isDefault;

Swift

var isDefault: NSNumber? { get set }


                    
                    
                    name

The name of the traffic distribution group.

Declaration

Objective-C

@property (nonatomic, strong) NSString *_Nullable name;

Swift

var name: String? { get set }


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

Declaration

Objective-C

@property (nonatomic) AWSConnectTrafficDistributionGroupStatus status;

Swift

var status: AWSConnectTrafficDistributionGroupStatus { get set }


                    
                    
                    tags

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

Declaration

Objective-C

@property (nonatomic, strong) NSDictionary<NSString *, NSString *> *_Nullable tags;

Swift

var tags: [String : String]? { get set }