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

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.
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.
  • certificate_id (str) – The value to assign to the certificate_id 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.
certificate_id

Gets the certificate_id of this CreateGatewayDetails. The OCID of the resource.

Returns:The certificate_id of this CreateGatewayDetails.
Return type:str
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
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))
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
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
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)
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