RegionSubscription¶

class oci.identity.models.RegionSubscription(**kwargs)¶

Bases: object

An object that represents your tenancy’s access to a particular region (i.e., a subscription), the status of that access, and whether that region is the home region. For more information, see Managing Regions.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Get Started with Policies.

Attributes

`STATUS_IN_PROGRESS`	A constant which can be used with the status property of a RegionSubscription.
`STATUS_READY`	A constant which can be used with the status property of a RegionSubscription.
`is_home_region`	[Required] Gets the is_home_region of this RegionSubscription.
`region_key`	[Required] Gets the region_key of this RegionSubscription.
`region_name`	[Required] Gets the region_name of this RegionSubscription.
`status`	[Required] Gets the status of this RegionSubscription.

Methods

__init__(**kwargs) Initializes a new RegionSubscription object with values from keyword arguments.

STATUS_IN_PROGRESS = 'IN_PROGRESS'¶: A constant which can be used with the status property of a RegionSubscription. This constant has a value of “IN_PROGRESS”

STATUS_READY = 'READY'¶: A constant which can be used with the status property of a RegionSubscription. This constant has a value of “READY”

__init__(**kwargs)¶

Initializes a new RegionSubscription object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

region_key (str) – The value to assign to the region_key property of this RegionSubscription.
region_name (str) – The value to assign to the region_name property of this RegionSubscription.
status (str) – The value to assign to the status property of this RegionSubscription. Allowed values for this property are: “READY”, “IN_PROGRESS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_home_region (bool) – The value to assign to the is_home_region property of this RegionSubscription.

is_home_region¶

[Required] Gets the is_home_region of this RegionSubscription. Indicates if the region is the home region or not.

Returns:	The is_home_region of this RegionSubscription.
Return type:	bool

region_key¶

[Required] Gets the region_key of this RegionSubscription. The region’s key. See Regions and Availability Domains for the full list of supported 3-letter region codes.

Example: PHX

Returns:	The region_key of this RegionSubscription.
Return type:	str

region_name¶

[Required] Gets the region_name of this RegionSubscription. The region’s name. See Regions and Availability Domains for the full list of supported region names.

Example: us-phoenix-1

Returns:	The region_name of this RegionSubscription.
Return type:	str

status¶

[Required] Gets the status of this RegionSubscription. The region subscription status.

Allowed values for this property are: “READY”, “IN_PROGRESS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The status of this RegionSubscription.
Return type:	str