CreateGatewayDetails

class oci.apigateway.models.CreateGatewayDetails(**kwargs)

Bases: object

Information about the new gateway.

Methods:

__init__(**kwargs)

Initializes a new CreateGatewayDetails object with values from keyword arguments.

Attributes:

ca_bundles

Gets the ca_bundles of this CreateGatewayDetails.

certificate_id

Gets the certificate_id of this CreateGatewayDetails.

compartment_id

[Required] Gets the compartment_id of this CreateGatewayDetails.

defined_tags

Gets the defined_tags of this CreateGatewayDetails.

display_name

Gets the display_name of this CreateGatewayDetails.

endpoint_type

[Required] Gets the endpoint_type of this CreateGatewayDetails.

freeform_tags

Gets the freeform_tags of this CreateGatewayDetails.

ip_mode

Gets the ip_mode of this CreateGatewayDetails.

ipv4_address_configuration

Gets the ipv4_address_configuration of this CreateGatewayDetails.

ipv6_address_configuration

Gets the ipv6_address_configuration of this CreateGatewayDetails.

locks

Gets the locks of this CreateGatewayDetails.

network_security_group_ids

Gets the network_security_group_ids of this CreateGatewayDetails.

response_cache_details

Gets the response_cache_details of this CreateGatewayDetails.

subnet_id

[Required] Gets the subnet_id of this CreateGatewayDetails.

__init__(**kwargs)

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

Parameters
  • display_name (str) – The value to assign to the display_name property of this CreateGatewayDetails.

  • compartment_id (str) – The value to assign to the compartment_id property of this CreateGatewayDetails.

  • endpoint_type (str) – The value to assign to the endpoint_type property of this CreateGatewayDetails.

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

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

  • certificate_id (str) – The value to assign to the certificate_id property of this CreateGatewayDetails.

  • response_cache_details (oci.apigateway.models.ResponseCacheDetails) – The value to assign to the response_cache_details property of this CreateGatewayDetails.

  • locks (list[oci.apigateway.models.AddResourceLockDetails]) – The value to assign to the locks property of this CreateGatewayDetails.

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

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

  • ca_bundles (list[oci.apigateway.models.CaBundle]) – The value to assign to the ca_bundles property of this CreateGatewayDetails.

  • ip_mode (str) – The value to assign to the ip_mode property of this CreateGatewayDetails.

  • ipv6_address_configuration (oci.apigateway.models.Ipv6AddressConfiguration) – The value to assign to the ipv6_address_configuration property of this CreateGatewayDetails.

  • ipv4_address_configuration (oci.apigateway.models.Ipv4AddressConfiguration) – The value to assign to the ipv4_address_configuration property of this CreateGatewayDetails.

property ca_bundles

Gets the ca_bundles of this CreateGatewayDetails. An array of CA bundles that should be used on the Gateway for TLS validation.

Returns

The ca_bundles of this CreateGatewayDetails.

Return type

list[oci.apigateway.models.CaBundle]

property certificate_id

Gets the certificate_id of this CreateGatewayDetails. The OCID of the resource which can be empty string.

Returns

The certificate_id of this CreateGatewayDetails.

Return type

str

property compartment_id

[Required] Gets the compartment_id of this CreateGatewayDetails. The OCID of the compartment in which the resource is created.

Returns

The compartment_id of this CreateGatewayDetails.

Return type

str

property defined_tags

Gets the defined_tags of this CreateGatewayDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The defined_tags of this CreateGatewayDetails.

Return type

dict(str, dict(str, object))

property display_name

Gets the display_name of this CreateGatewayDetails. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Example: My new resource

Returns

The display_name of this CreateGatewayDetails.

Return type

str

property endpoint_type

[Required] Gets the endpoint_type of this CreateGatewayDetails. Gateway endpoint type. PUBLIC will have a public ip address assigned to it, while PRIVATE will only be accessible on a private IP address on the subnet.

Example: PUBLIC or PRIVATE

Returns

The endpoint_type of this CreateGatewayDetails.

Return type

str

property freeform_tags

Gets the freeform_tags of this CreateGatewayDetails. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

Returns

The freeform_tags of this CreateGatewayDetails.

Return type

dict(str, str)

property ip_mode

Gets the ip_mode of this CreateGatewayDetails. Determines whether the gateway has an IPv4 or IPv6 address assigned to it, or both. IPV4 means the gateway will only have an IPv4 address assigned to it, and IPV6 means the gateway will only have an IPv6 address assigned to it. DUAL_STACK means the gateway will have both an IPv4 and IPv6 address assigned to it. Example: IPV4 or IPV6 or DUAL_STACK

Returns

The ip_mode of this CreateGatewayDetails.

Return type

str

property ipv4_address_configuration

Gets the ipv4_address_configuration of this CreateGatewayDetails.

Returns

The ipv4_address_configuration of this CreateGatewayDetails.

Return type

oci.apigateway.models.Ipv4AddressConfiguration

property ipv6_address_configuration

Gets the ipv6_address_configuration of this CreateGatewayDetails.

Returns

The ipv6_address_configuration of this CreateGatewayDetails.

Return type

oci.apigateway.models.Ipv6AddressConfiguration

property locks

Gets the locks of this CreateGatewayDetails. Locks associated with this resource.

Returns

The locks of this CreateGatewayDetails.

Return type

list[oci.apigateway.models.AddResourceLockDetails]

property network_security_group_ids

Gets the network_security_group_ids of this CreateGatewayDetails. An array of Network Security Groups OCIDs associated with this API Gateway.

Returns

The network_security_group_ids of this CreateGatewayDetails.

Return type

list[str]

property response_cache_details

Gets the response_cache_details of this CreateGatewayDetails.

Returns

The response_cache_details of this CreateGatewayDetails.

Return type

oci.apigateway.models.ResponseCacheDetails

property subnet_id

[Required] Gets the subnet_id of this CreateGatewayDetails. The OCID of the subnet in which related resources are created.

Returns

The subnet_id of this CreateGatewayDetails.

Return type

str