CreateResolverVnicEndpointDetails

class oci.dns.models.CreateResolverVnicEndpointDetails(**kwargs)

Bases: CreateResolverEndpointDetails

The body for defining a new resolver VNIC endpoint. Either isForwarding or isListening must be true, but not both. If isListening is true, a listeningAddress may be provided. If isForwarding is true, a forwardingAddress may be provided. When not provided, an address will be chosen automatically.

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

Attributes:

ENDPOINT_TYPE_VNIC

A constant which can be used with the endpoint_type property of a CreateResolverEndpointDetails.

defined_tags

Gets the defined_tags of this CreateResolverEndpointDetails.

endpoint_type

Gets the endpoint_type of this CreateResolverEndpointDetails.

forwarding_address

Gets the forwarding_address of this CreateResolverEndpointDetails.

freeform_tags

Gets the freeform_tags of this CreateResolverEndpointDetails.

is_forwarding

[Required] Gets the is_forwarding of this CreateResolverEndpointDetails.

is_listening

[Required] Gets the is_listening of this CreateResolverEndpointDetails.

listening_address

Gets the listening_address of this CreateResolverEndpointDetails.

name

[Required] Gets the name of this CreateResolverEndpointDetails.

nsg_ids

Gets the nsg_ids of this CreateResolverVnicEndpointDetails.

security_attributes

Gets the security_attributes of this CreateResolverVnicEndpointDetails.

subnet_id

[Required] Gets the subnet_id of this CreateResolverVnicEndpointDetails.

Methods:

__init__(**kwargs)

Initializes a new CreateResolverVnicEndpointDetails 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'

A constant which can be used with the endpoint_type property of a CreateResolverEndpointDetails. This constant has a value of “VNIC”

__init__(**kwargs)

Initializes a new CreateResolverVnicEndpointDetails 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 CreateResolverVnicEndpointDetails.

  • endpoint_type (str) – The value to assign to the endpoint_type property of this CreateResolverVnicEndpointDetails. Allowed values for this property are: “VNIC”

  • forwarding_address (str) – The value to assign to the forwarding_address property of this CreateResolverVnicEndpointDetails.

  • is_forwarding (bool) – The value to assign to the is_forwarding property of this CreateResolverVnicEndpointDetails.

  • is_listening (bool) – The value to assign to the is_listening property of this CreateResolverVnicEndpointDetails.

  • listening_address (str) – The value to assign to the listening_address property of this CreateResolverVnicEndpointDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateResolverVnicEndpointDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateResolverVnicEndpointDetails.

  • subnet_id (str) – The value to assign to the subnet_id property of this CreateResolverVnicEndpointDetails.

  • nsg_ids (list[str]) – The value to assign to the nsg_ids property of this CreateResolverVnicEndpointDetails.

  • security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this CreateResolverVnicEndpointDetails.

property defined_tags

Gets the defined_tags of this CreateResolverEndpointDetails.

Returns

The defined_tags of this CreateResolverEndpointDetails.

Return type

dict(str, dict(str, object))

property endpoint_type

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

Allowed values for this property are: “VNIC”

Returns

The endpoint_type of this CreateResolverEndpointDetails.

Return type

str

property forwarding_address

Gets the forwarding_address of this CreateResolverEndpointDetails. 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 CreateResolverEndpointDetails.

Return type

str

property freeform_tags

Gets the freeform_tags of this CreateResolverEndpointDetails.

Returns

The freeform_tags of this CreateResolverEndpointDetails.

Return type

dict(str, 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.

property is_forwarding

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

Returns

The is_forwarding of this CreateResolverEndpointDetails.

Return type

bool

property is_listening

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

Returns

The is_listening of this CreateResolverEndpointDetails.

Return type

bool

property listening_address

Gets the listening_address of this CreateResolverEndpointDetails. 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 CreateResolverEndpointDetails.

Return type

str

property name

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

Returns

The name of this CreateResolverEndpointDetails.

Return type

str

property nsg_ids

Gets the nsg_ids of this CreateResolverVnicEndpointDetails. 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 CreateResolverVnicEndpointDetails.

Return type

list[str]

property security_attributes

Gets the security_attributes of this CreateResolverVnicEndpointDetails.

Returns

The security_attributes of this CreateResolverVnicEndpointDetails.

Return type

dict(str, dict(str, object))

property subnet_id

[Required] Gets the subnet_id of this CreateResolverVnicEndpointDetails. The OCID of a subnet. Must be part of the VCN that the resolver is attached to.

Returns

The subnet_id of this CreateResolverVnicEndpointDetails.

Return type

str