ResolverVnicEndpoint¶

class oci.dns.models.ResolverVnicEndpoint(**kwargs)¶

Bases: oci.dns.models.resolver_endpoint.ResolverEndpoint

An OCI DNS resolver VNIC endpoint. A VNIC is created for each ResolverVnicEndpoint. VCNs and subnets cannot be deleted while ResolverVnicEndpoints exist in them due to the VNIC.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Attributes

`ENDPOINT_TYPE_VNIC`	str(object=’’) -> str
`LIFECYCLE_STATE_ACTIVE`	str(object=’’) -> str
`LIFECYCLE_STATE_CREATING`	str(object=’’) -> str
`LIFECYCLE_STATE_DELETED`	str(object=’’) -> str
`LIFECYCLE_STATE_DELETING`	str(object=’’) -> str
`LIFECYCLE_STATE_FAILED`	str(object=’’) -> str
`LIFECYCLE_STATE_UPDATING`	str(object=’’) -> str
`compartment_id`	[Required] Gets the compartment_id of this ResolverEndpoint.
`endpoint_type`	Gets the endpoint_type of this ResolverEndpoint.
`forwarding_address`	Gets the forwarding_address of this ResolverEndpoint.
`is_forwarding`	[Required] Gets the is_forwarding of this ResolverEndpoint.
`is_listening`	[Required] Gets the is_listening of this ResolverEndpoint.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ResolverEndpoint.
`listening_address`	Gets the listening_address of this ResolverEndpoint.
`name`	[Required] Gets the name of this ResolverEndpoint.
`nsg_ids`	Gets the nsg_ids of this ResolverVnicEndpoint.
`subnet_id`	Gets the subnet_id of this ResolverVnicEndpoint.
`time_created`	[Required] Gets the time_created of this ResolverEndpoint.
`time_updated`	[Required] Gets the time_updated of this ResolverEndpoint.

Methods

`__init__`(**kwargs)	Initializes a new ResolverVnicEndpoint object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

ENDPOINT_TYPE_VNIC = 'VNIC'¶

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶

LIFECYCLE_STATE_CREATING = 'CREATING'¶

LIFECYCLE_STATE_DELETED = 'DELETED'¶

LIFECYCLE_STATE_DELETING = 'DELETING'¶

LIFECYCLE_STATE_FAILED = 'FAILED'¶

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶

__init__(**kwargs)¶

Initializes a new ResolverVnicEndpoint object with values from keyword arguments. The default value of the endpoint_type attribute of this class is VNIC and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

name (str) – The value to assign to the name property of this ResolverVnicEndpoint.
endpoint_type (str) – The value to assign to the endpoint_type property of this ResolverVnicEndpoint. Allowed values for this property are: “VNIC”
forwarding_address (str) – The value to assign to the forwarding_address property of this ResolverVnicEndpoint.
is_forwarding (bool) – The value to assign to the is_forwarding property of this ResolverVnicEndpoint.
is_listening (bool) – The value to assign to the is_listening property of this ResolverVnicEndpoint.
listening_address (str) – The value to assign to the listening_address property of this ResolverVnicEndpoint.
compartment_id (str) – The value to assign to the compartment_id property of this ResolverVnicEndpoint.
time_created (datetime) – The value to assign to the time_created property of this ResolverVnicEndpoint.
time_updated (datetime) – The value to assign to the time_updated property of this ResolverVnicEndpoint.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ResolverVnicEndpoint. Allowed values for this property are: “ACTIVE”, “CREATING”, “DELETED”, “DELETING”, “FAILED”, “UPDATING”
_self (str) – The value to assign to the _self property of this ResolverVnicEndpoint.
subnet_id (str) – The value to assign to the subnet_id property of this ResolverVnicEndpoint.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this ResolverVnicEndpoint.

compartment_id¶

[Required] Gets the compartment_id of this ResolverEndpoint. The OCID of the owning compartment. This will match the resolver that the resolver endpoint is under and will be updated if the resolver’s compartment is changed.

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

endpoint_type¶

Gets the endpoint_type of this ResolverEndpoint. The type of resolver endpoint. VNIC is currently the only supported type.

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

Returns:	The endpoint_type of this ResolverEndpoint.
Return type:	str

forwarding_address¶

Gets the forwarding_address of this ResolverEndpoint. An IP address from which forwarded queries may be sent. For VNIC endpoints, this IP address must be part of the subnet and will be assigned by the system if unspecified when isForwarding is true.

Returns:	The forwarding_address of this ResolverEndpoint.
Return type:	str

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

is_forwarding¶

[Required] Gets the is_forwarding of this ResolverEndpoint. A Boolean flag indicating whether or not the resolver endpoint is for forwarding.

Returns:	The is_forwarding of this ResolverEndpoint.
Return type:	bool

is_listening¶

[Required] Gets the is_listening of this ResolverEndpoint. A Boolean flag indicating whether or not the resolver endpoint is for listening.

Returns:	The is_listening of this ResolverEndpoint.
Return type:	bool

lifecycle_state¶

[Required] Gets the lifecycle_state of this ResolverEndpoint. The current state of the resource.

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

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

listening_address¶

Gets the listening_address of this ResolverEndpoint. An IP address to listen to queries on. For VNIC endpoints this IP address must be part of the subnet and will be assigned by the system if unspecified when isListening is true.

Returns:	The listening_address of this ResolverEndpoint.
Return type:	str

name¶

[Required] Gets the name of this ResolverEndpoint. The name of the resolver endpoint. Must be unique, case-insensitive, within the resolver.

Returns:	The name of this ResolverEndpoint.
Return type:	str

nsg_ids¶

Gets the nsg_ids of this ResolverVnicEndpoint. An array of network security group OCIDs for the resolver endpoint. These must be part of the VCN that the resolver endpoint is a part of.

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

subnet_id¶

Gets the subnet_id of this ResolverVnicEndpoint. The OCID of a subnet. Must be part of the VCN that the resolver is attached to.

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

time_created¶

[Required] Gets the time_created of this ResolverEndpoint. The date and time the resource was created in “YYYY-MM-ddThh:mm:ssZ” format with a Z offset, as defined by RFC 3339.

Example: 2016-07-22T17:23:59:60Z

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

time_updated¶

[Required] Gets the time_updated of this ResolverEndpoint. The date and time the resource was last updated in “YYYY-MM-ddThh:mm:ssZ” format with a Z offset, as defined by RFC 3339.

Example: 2016-07-22T17:23:59:60Z

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