RecoveryServiceSubnetSummary¶

class oci.recovery.models.RecoveryServiceSubnetSummary(**kwargs)¶

Bases: object

Each Recovery Service subnet uses a single private endpoint on a subnet of your choice within a VCN. The private endpoint need not be on the same subnet as the Oracle Cloud Database, although, it must be on a subnet that can communicate with the Oracle Cloud Database. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies. For information about access control and compartments, see Overview of the Identity Service.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a RecoveryServiceSubnetSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a RecoveryServiceSubnetSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a RecoveryServiceSubnetSummary.
`LIFECYCLE_STATE_DELETE_SCHEDULED`	A constant which can be used with the lifecycle_state property of a RecoveryServiceSubnetSummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a RecoveryServiceSubnetSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a RecoveryServiceSubnetSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a RecoveryServiceSubnetSummary.
`compartment_id`	[Required] Gets the compartment_id of this RecoveryServiceSubnetSummary.
`defined_tags`	Gets the defined_tags of this RecoveryServiceSubnetSummary.
`display_name`	Gets the display_name of this RecoveryServiceSubnetSummary.
`freeform_tags`	Gets the freeform_tags of this RecoveryServiceSubnetSummary.
`id`	[Required] Gets the id of this RecoveryServiceSubnetSummary.
`lifecycle_details`	Gets the lifecycle_details of this RecoveryServiceSubnetSummary.
`lifecycle_state`	Gets the lifecycle_state of this RecoveryServiceSubnetSummary.
`nsg_ids`	Gets the nsg_ids of this RecoveryServiceSubnetSummary.
`subnet_id`	[Required] Gets the subnet_id of this RecoveryServiceSubnetSummary.
`subnets`	Gets the subnets of this RecoveryServiceSubnetSummary.
`system_tags`	Gets the system_tags of this RecoveryServiceSubnetSummary.
`time_created`	Gets the time_created of this RecoveryServiceSubnetSummary.
`time_updated`	Gets the time_updated of this RecoveryServiceSubnetSummary.
`vcn_id`	[Required] Gets the vcn_id of this RecoveryServiceSubnetSummary.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a RecoveryServiceSubnetSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a RecoveryServiceSubnetSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a RecoveryServiceSubnetSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETE_SCHEDULED = 'DELETE_SCHEDULED'¶: A constant which can be used with the lifecycle_state property of a RecoveryServiceSubnetSummary. This constant has a value of “DELETE_SCHEDULED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a RecoveryServiceSubnetSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a RecoveryServiceSubnetSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a RecoveryServiceSubnetSummary. This constant has a value of “UPDATING”

__init__(**kwargs)¶

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

Parameters:

id (str) – The value to assign to the id property of this RecoveryServiceSubnetSummary.
display_name (str) – The value to assign to the display_name property of this RecoveryServiceSubnetSummary.
compartment_id (str) – The value to assign to the compartment_id property of this RecoveryServiceSubnetSummary.
vcn_id (str) – The value to assign to the vcn_id property of this RecoveryServiceSubnetSummary.
subnet_id (str) – The value to assign to the subnet_id property of this RecoveryServiceSubnetSummary.
subnets (list[str]) – The value to assign to the subnets property of this RecoveryServiceSubnetSummary.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this RecoveryServiceSubnetSummary.
time_created (datetime) – The value to assign to the time_created property of this RecoveryServiceSubnetSummary.
time_updated (datetime) – The value to assign to the time_updated property of this RecoveryServiceSubnetSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this RecoveryServiceSubnetSummary. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETE_SCHEDULED”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this RecoveryServiceSubnetSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this RecoveryServiceSubnetSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this RecoveryServiceSubnetSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this RecoveryServiceSubnetSummary.

compartment_id¶

[Required] Gets the compartment_id of this RecoveryServiceSubnetSummary. The compartment OCID.

Returns:	The compartment_id of this RecoveryServiceSubnetSummary.
Return type:	str

defined_tags¶

Gets the defined_tags of this RecoveryServiceSubnetSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}. For more information, see Resource Tags

Returns:	The defined_tags of this RecoveryServiceSubnetSummary.
Return type:	dict(str, dict(str, object))

display_name¶

Gets the display_name of this RecoveryServiceSubnetSummary. A user-provided name for the recovery service subnet.

Returns:	The display_name of this RecoveryServiceSubnetSummary.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this RecoveryServiceSubnetSummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this RecoveryServiceSubnetSummary.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this RecoveryServiceSubnetSummary. The recovery service subnet OCID.

Returns:	The id of this RecoveryServiceSubnetSummary.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this RecoveryServiceSubnetSummary. Detailed description about the current lifecycle state of the recovery service subnet. For example, it can be used to provide actionable information for a resource in a Failed state

Returns:	The lifecycle_details of this RecoveryServiceSubnetSummary.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this RecoveryServiceSubnetSummary. The current state of the recovery service subnet.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETE_SCHEDULED”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this RecoveryServiceSubnetSummary.
Return type:	str

nsg_ids¶

Gets the nsg_ids of this RecoveryServiceSubnetSummary. A list of network security group (NSG) OCIDs that are associated with the Recovery Service subnet. You can specify a maximum of 5 unique OCIDs, which implies that you can associate a maximum of 5 NSGs to each Recovery Service subnet. Specify an empty array if you want to remove all the associated NSGs from a Recovery Service subnet. See NetworkSecurityGroup for more information.

Returns:	The nsg_ids of this RecoveryServiceSubnetSummary.
Return type:	list[str]

subnet_id¶

[Required] Gets the subnet_id of this RecoveryServiceSubnetSummary. Deprecated. One of the subnets associated with the Recovery Service subnet.

Returns:	The subnet_id of this RecoveryServiceSubnetSummary.
Return type:	str

subnets¶

Gets the subnets of this RecoveryServiceSubnetSummary. A list of OCIDs of all the subnets associated with the Recovery Service subnet.

Returns:	The subnets of this RecoveryServiceSubnetSummary.
Return type:	list[str]

system_tags¶

Gets the system_tags of this RecoveryServiceSubnetSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}. For more information, see Resource Tags

Returns:	The system_tags of this RecoveryServiceSubnetSummary.
Return type:	dict(str, dict(str, object))

time_created¶

Gets the time_created of this RecoveryServiceSubnetSummary. An RFC3339 formatted datetime string that indicates the last created time for a recovery service subnet. For example: ‘2020-05-22T21:10:29.600Z’.

Returns:	The time_created of this RecoveryServiceSubnetSummary.
Return type:	datetime

time_updated¶

Gets the time_updated of this RecoveryServiceSubnetSummary. An RFC3339 formatted datetime string that indicates the last updated time for a recovery service subnet. For example: ‘2020-05-22T21:10:29.600Z’.

Returns:	The time_updated of this RecoveryServiceSubnetSummary.
Return type:	datetime

vcn_id¶

[Required] Gets the vcn_id of this RecoveryServiceSubnetSummary. The OCID of the virtual cloud network (VCN) associated with the recovery service subnet. You can create a single recovery service subnet per VCN.

Returns:	The vcn_id of this RecoveryServiceSubnetSummary.
Return type:	str