CustomEndpointDetails

class oci.integration.models.CustomEndpointDetails(**kwargs)

Bases: object

Details for a custom endpoint for the integration instance.

Attributes:

DNS_TYPE_OCI

A constant which can be used with the dns_type property of a CustomEndpointDetails.

MANAGED_TYPE_CUSTOMER_MANAGED

A constant which can be used with the managed_type property of a CustomEndpointDetails.

MANAGED_TYPE_ORACLE_MANAGED

A constant which can be used with the managed_type property of a CustomEndpointDetails.

alias

Gets the alias of this CustomEndpointDetails.

certificate_secret_id

Gets the certificate_secret_id of this CustomEndpointDetails.

certificate_secret_version

Gets the certificate_secret_version of this CustomEndpointDetails.

dns_type

Gets the dns_type of this CustomEndpointDetails.

dns_zone_name

Gets the dns_zone_name of this CustomEndpointDetails.

hostname

[Required] Gets the hostname of this CustomEndpointDetails.

managed_type

Gets the managed_type of this CustomEndpointDetails.

Methods:

__init__(**kwargs)

Initializes a new CustomEndpointDetails object with values from keyword arguments.

DNS_TYPE_OCI = 'OCI'

A constant which can be used with the dns_type property of a CustomEndpointDetails. This constant has a value of “OCI”

MANAGED_TYPE_CUSTOMER_MANAGED = 'CUSTOMER_MANAGED'

A constant which can be used with the managed_type property of a CustomEndpointDetails. This constant has a value of “CUSTOMER_MANAGED”

MANAGED_TYPE_ORACLE_MANAGED = 'ORACLE_MANAGED'

A constant which can be used with the managed_type property of a CustomEndpointDetails. This constant has a value of “ORACLE_MANAGED”

__init__(**kwargs)

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

Parameters
  • hostname (str) – The value to assign to the hostname property of this CustomEndpointDetails.

  • managed_type (str) – The value to assign to the managed_type property of this CustomEndpointDetails. Allowed values for this property are: “ORACLE_MANAGED”, “CUSTOMER_MANAGED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • dns_zone_name (str) – The value to assign to the dns_zone_name property of this CustomEndpointDetails.

  • dns_type (str) – The value to assign to the dns_type property of this CustomEndpointDetails. Allowed values for this property are: “OCI”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • certificate_secret_id (str) – The value to assign to the certificate_secret_id property of this CustomEndpointDetails.

  • certificate_secret_version (int) – The value to assign to the certificate_secret_version property of this CustomEndpointDetails.

  • alias (str) – The value to assign to the alias property of this CustomEndpointDetails.

property alias

Gets the alias of this CustomEndpointDetails. When creating the DNS CNAME record for the custom hostname, this value must be specified in the rdata.

Returns

The alias of this CustomEndpointDetails.

Return type

str

property certificate_secret_id

Gets the certificate_secret_id of this CustomEndpointDetails. Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname.

Returns

The certificate_secret_id of this CustomEndpointDetails.

Return type

str

property certificate_secret_version

Gets the certificate_secret_version of this CustomEndpointDetails. The secret version used for the certificate-secret-id (if certificate-secret-id is specified).

Returns

The certificate_secret_version of this CustomEndpointDetails.

Return type

int

property dns_type

Gets the dns_type of this CustomEndpointDetails. Type of DNS.

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

Returns

The dns_type of this CustomEndpointDetails.

Return type

str

property dns_zone_name

Gets the dns_zone_name of this CustomEndpointDetails. DNS Zone name

Returns

The dns_zone_name of this CustomEndpointDetails.

Return type

str

property hostname

[Required] Gets the hostname of this CustomEndpointDetails. A custom hostname to be used for the integration instance URL, in FQDN format.

Returns

The hostname of this CustomEndpointDetails.

Return type

str

property managed_type

Gets the managed_type of this CustomEndpointDetails. Indicates if custom endpoint is managed by oracle or customer.

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

Returns

The managed_type of this CustomEndpointDetails.

Return type

str