CloudGateMapping

class oci.identity_domains.models.CloudGateMapping(**kwargs)

Bases: object

Resource representing a Cloud Gate mapping

Attributes:

IDCS_PREVENTED_OPERATIONS_DELETE

A constant which can be used with the idcs_prevented_operations property of a CloudGateMapping.

IDCS_PREVENTED_OPERATIONS_REPLACE

A constant which can be used with the idcs_prevented_operations property of a CloudGateMapping.

IDCS_PREVENTED_OPERATIONS_UPDATE

A constant which can be used with the idcs_prevented_operations property of a CloudGateMapping.

cloud_gate

[Required] Gets the cloud_gate of this CloudGateMapping.

compartment_ocid

Gets the compartment_ocid of this CloudGateMapping.

delete_in_progress

Gets the delete_in_progress of this CloudGateMapping.

description

Gets the description of this CloudGateMapping.

domain_ocid

Gets the domain_ocid of this CloudGateMapping.

gateway_app

[Required] Gets the gateway_app of this CloudGateMapping.

id

Gets the id of this CloudGateMapping.

idcs_created_by

Gets the idcs_created_by of this CloudGateMapping.

idcs_last_modified_by

Gets the idcs_last_modified_by of this CloudGateMapping.

idcs_last_upgraded_in_release

Gets the idcs_last_upgraded_in_release of this CloudGateMapping.

idcs_prevented_operations

Gets the idcs_prevented_operations of this CloudGateMapping.

is_opc_service

Gets the is_opc_service of this CloudGateMapping.

meta

Gets the meta of this CloudGateMapping.

nginx_settings

Gets the nginx_settings of this CloudGateMapping.

ocid

Gets the ocid of this CloudGateMapping.

policy_name

[Required] Gets the policy_name of this CloudGateMapping.

proxy_pass

Gets the proxy_pass of this CloudGateMapping.

resource_prefix

[Required] Gets the resource_prefix of this CloudGateMapping.

schemas

[Required] Gets the schemas of this CloudGateMapping.

server

[Required] Gets the server of this CloudGateMapping.

tags

Gets the tags of this CloudGateMapping.

tenancy_ocid

Gets the tenancy_ocid of this CloudGateMapping.

upstream_server_group

Gets the upstream_server_group of this CloudGateMapping.

Methods:

__init__(**kwargs)

Initializes a new CloudGateMapping object with values from keyword arguments.

IDCS_PREVENTED_OPERATIONS_DELETE = 'delete'

A constant which can be used with the idcs_prevented_operations property of a CloudGateMapping. This constant has a value of “delete”

IDCS_PREVENTED_OPERATIONS_REPLACE = 'replace'

A constant which can be used with the idcs_prevented_operations property of a CloudGateMapping. This constant has a value of “replace”

IDCS_PREVENTED_OPERATIONS_UPDATE = 'update'

A constant which can be used with the idcs_prevented_operations property of a CloudGateMapping. This constant has a value of “update”

__init__(**kwargs)

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

  • ocid (str) – The value to assign to the ocid property of this CloudGateMapping.

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

  • meta (oci.identity_domains.models.Meta) – The value to assign to the meta property of this CloudGateMapping.

  • idcs_created_by (oci.identity_domains.models.IdcsCreatedBy) – The value to assign to the idcs_created_by property of this CloudGateMapping.

  • idcs_last_modified_by (oci.identity_domains.models.IdcsLastModifiedBy) – The value to assign to the idcs_last_modified_by property of this CloudGateMapping.

  • idcs_prevented_operations (list[str]) – The value to assign to the idcs_prevented_operations property of this CloudGateMapping. Allowed values for items in this list are: “replace”, “update”, “delete”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • tags (list[oci.identity_domains.models.Tags]) – The value to assign to the tags property of this CloudGateMapping.

  • delete_in_progress (bool) – The value to assign to the delete_in_progress property of this CloudGateMapping.

  • idcs_last_upgraded_in_release (str) – The value to assign to the idcs_last_upgraded_in_release property of this CloudGateMapping.

  • domain_ocid (str) – The value to assign to the domain_ocid property of this CloudGateMapping.

  • compartment_ocid (str) – The value to assign to the compartment_ocid property of this CloudGateMapping.

  • tenancy_ocid (str) – The value to assign to the tenancy_ocid property of this CloudGateMapping.

  • is_opc_service (bool) – The value to assign to the is_opc_service property of this CloudGateMapping.

  • description (str) – The value to assign to the description property of this CloudGateMapping.

  • resource_prefix (str) – The value to assign to the resource_prefix property of this CloudGateMapping.

  • proxy_pass (str) – The value to assign to the proxy_pass property of this CloudGateMapping.

  • nginx_settings (str) – The value to assign to the nginx_settings property of this CloudGateMapping.

  • policy_name (str) – The value to assign to the policy_name property of this CloudGateMapping.

  • upstream_server_group (oci.identity_domains.models.CloudGateMappingUpstreamServerGroup) – The value to assign to the upstream_server_group property of this CloudGateMapping.

  • server (oci.identity_domains.models.CloudGateMappingServer) – The value to assign to the server property of this CloudGateMapping.

  • gateway_app (oci.identity_domains.models.CloudGateMappingGatewayApp) – The value to assign to the gateway_app property of this CloudGateMapping.

  • cloud_gate (oci.identity_domains.models.CloudGateMappingCloudGate) – The value to assign to the cloud_gate property of this CloudGateMapping.

property cloud_gate

[Required] Gets the cloud_gate of this CloudGateMapping.

Returns

The cloud_gate of this CloudGateMapping.

Return type

oci.identity_domains.models.CloudGateMappingCloudGate

property compartment_ocid

Gets the compartment_ocid of this CloudGateMapping. OCI Compartment Id (ocid) in which the resource lives.

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: false

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The compartment_ocid of this CloudGateMapping.

Return type

str

property delete_in_progress

Gets the delete_in_progress of this CloudGateMapping. A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: true

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • type: boolean

  • uniqueness: none

Returns

The delete_in_progress of this CloudGateMapping.

Return type

bool

property description

Gets the description of this CloudGateMapping. Brief description for this Cloud Gate

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: false

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The description of this CloudGateMapping.

Return type

str

property domain_ocid

Gets the domain_ocid of this CloudGateMapping. OCI Domain Id (ocid) in which the resource lives.

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: false

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The domain_ocid of this CloudGateMapping.

Return type

str

property gateway_app

[Required] Gets the gateway_app of this CloudGateMapping.

Returns

The gateway_app of this CloudGateMapping.

Return type

oci.identity_domains.models.CloudGateMappingGatewayApp

property id

Gets the id of this CloudGateMapping. Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider’s entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: true

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: always

  • type: string

  • uniqueness: global

Returns

The id of this CloudGateMapping.

Return type

str

property idcs_created_by

Gets the idcs_created_by of this CloudGateMapping.

Returns

The idcs_created_by of this CloudGateMapping.

Return type

oci.identity_domains.models.IdcsCreatedBy

property idcs_last_modified_by

Gets the idcs_last_modified_by of this CloudGateMapping.

Returns

The idcs_last_modified_by of this CloudGateMapping.

Return type

oci.identity_domains.models.IdcsLastModifiedBy

property idcs_last_upgraded_in_release

Gets the idcs_last_upgraded_in_release of this CloudGateMapping. The release number when the resource was upgraded.

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: false

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: request

  • type: string

  • uniqueness: none

Returns

The idcs_last_upgraded_in_release of this CloudGateMapping.

Return type

str

property idcs_prevented_operations

Gets the idcs_prevented_operations of this CloudGateMapping. Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.

SCIM++ Properties:
  • idcsSearchable: false

  • multiValued: true

  • mutability: readOnly

  • required: false

  • returned: request

  • type: string

  • uniqueness: none

Allowed values for items in this list are: “replace”, “update”, “delete”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The idcs_prevented_operations of this CloudGateMapping.

Return type

list[str]

property is_opc_service

Gets the is_opc_service of this CloudGateMapping. Indicates whether this resource was created by OPC

Added In: 19.3.3

SCIM++ Properties:
  • caseExact: true

  • idcsSearchable: true

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: always

  • type: boolean

  • uniqueness: none

Returns

The is_opc_service of this CloudGateMapping.

Return type

bool

property meta

Gets the meta of this CloudGateMapping.

Returns

The meta of this CloudGateMapping.

Return type

oci.identity_domains.models.Meta

property nginx_settings

Gets the nginx_settings of this CloudGateMapping. More NGINX Settings. JSON encoded key value pairs similar to WTP encoding

SCIM++ Properties:
  • caseExact: true

  • idcsSearchable: false

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The nginx_settings of this CloudGateMapping.

Return type

str

property ocid

Gets the ocid of this CloudGateMapping. Unique OCI identifier for the SCIM Resource.

SCIM++ Properties:
  • caseExact: true

  • idcsSearchable: true

  • multiValued: false

  • mutability: immutable

  • required: false

  • returned: default

  • type: string

  • uniqueness: global

Returns

The ocid of this CloudGateMapping.

Return type

str

property policy_name

[Required] Gets the policy_name of this CloudGateMapping. The Web Tier policy name used for the App that is mapped to the owning Cloud Gate

SCIM++ Properties:
  • caseExact: true

  • idcsSearchable: false

  • multiValued: false

  • mutability: readWrite

  • required: true

  • returned: default

  • type: string

  • uniqueness: none

Returns

The policy_name of this CloudGateMapping.

Return type

str

property proxy_pass

Gets the proxy_pass of this CloudGateMapping. NGINX ProxyPass entry for this Mapping

SCIM++ Properties:
  • caseExact: true

  • idcsSearchable: false

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The proxy_pass of this CloudGateMapping.

Return type

str

property resource_prefix

[Required] Gets the resource_prefix of this CloudGateMapping. Resource prefix for this mapping. This will be used to define the location block

SCIM++ Properties:
  • caseExact: true

  • idcsSearchable: false

  • multiValued: false

  • mutability: readWrite

  • required: true

  • returned: default

  • type: string

  • uniqueness: none

Returns

The resource_prefix of this CloudGateMapping.

Return type

str

property schemas

[Required] Gets the schemas of this CloudGateMapping. REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard “enterprise” extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: false

  • multiValued: true

  • mutability: readWrite

  • required: true

  • returned: default

  • type: string

  • uniqueness: none

Returns

The schemas of this CloudGateMapping.

Return type

list[str]

property server

[Required] Gets the server of this CloudGateMapping.

Returns

The server of this CloudGateMapping.

Return type

oci.identity_domains.models.CloudGateMappingServer

property tags

Gets the tags of this CloudGateMapping. A list of tags on this resource.

SCIM++ Properties:
  • idcsCompositeKey: [key, value]

  • idcsSearchable: true

  • multiValued: true

  • mutability: readWrite

  • required: false

  • returned: request

  • type: complex

  • uniqueness: none

Returns

The tags of this CloudGateMapping.

Return type

list[oci.identity_domains.models.Tags]

property tenancy_ocid

Gets the tenancy_ocid of this CloudGateMapping. OCI Tenant Id (ocid) in which the resource lives.

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: false

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The tenancy_ocid of this CloudGateMapping.

Return type

str

property upstream_server_group

Gets the upstream_server_group of this CloudGateMapping.

Returns

The upstream_server_group of this CloudGateMapping.

Return type

oci.identity_domains.models.CloudGateMappingUpstreamServerGroup