Skip to content

MultiRegionAccessPointRoute

Source code in docs_src/capo_s3_control/types/multi_region_access_point_route.py 
16
17
18
19
20
21
22
23
24
class MultiRegionAccessPointRoute(TypedDict, closed=True):
    bucket: NotRequired["capo_s3_control.types.bucket_name.BucketName"]
    """<p>The name of the Amazon S3 bucket for which you'll submit a routing configuration change. Either the <code>Bucket</code> or the <code>Region</code> value must be provided. If both are provided, the bucket must be in the specified Region.</p>"""
    region: NotRequired["capo_s3_control.types.region_name.RegionName"]
    """<p>The Amazon Web Services Region to which you'll be submitting a routing configuration change. Either the <code>Bucket</code> or the <code>Region</code> value must be provided. If both are provided, the bucket must be in the specified Region.</p>"""
    traffic_dial_percentage: (
        "capo_s3_control.types.traffic_dial_percentage.TrafficDialPercentage"
    )
    """<p>The traffic state for the specified bucket or Amazon Web Services Region. </p> <p>A value of <code>0</code> indicates a passive state, which means that no new traffic will be routed to the Region. </p> <p>A value of <code>100</code> indicates an active state, which means that traffic will be routed to the specified Region. </p> <p>When the routing configuration for a Region is changed from active to passive, any in-progress operations (uploads, copies, deletes, and so on) to the formerly active Region will continue to run to until a final success or failure status is reached.</p> <p>If all Regions in the routing configuration are designated as passive, you'll receive an <code>InvalidRequest</code> error.</p>"""

bucket instance-attribute 

bucket: NotRequired[BucketName]

The name of the Amazon S3 bucket for which you'll submit a routing configuration change. Either the Bucket or the Region value must be provided. If both are provided, the bucket must be in the specified Region.

region instance-attribute 

region: NotRequired[RegionName]

The Amazon Web Services Region to which you'll be submitting a routing configuration change. Either the Bucket or the Region value must be provided. If both are provided, the bucket must be in the specified Region.

traffic_dial_percentage instance-attribute 

traffic_dial_percentage: TrafficDialPercentage

The traffic state for the specified bucket or Amazon Web Services Region.

A value of 0 indicates a passive state, which means that no new traffic will be routed to the Region.

A value of 100 indicates an active state, which means that traffic will be routed to the specified Region.

When the routing configuration for a Region is changed from active to passive, any in-progress operations (uploads, copies, deletes, and so on) to the formerly active Region will continue to run to until a final success or failure status is reached.

If all Regions in the routing configuration are designated as passive, you'll receive an InvalidRequest error.