CreateServiceGatewayDetails

class oci.core.models.CreateServiceGatewayDetails(**kwargs)

Bases: object

CreateServiceGatewayDetails model.

__init__(**kwargs)

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

Parameters:
  • compartment_id (str) -- The value to assign to the compartment_id property of this CreateServiceGatewayDetails.
  • defined_tags (dict(str, dict(str, object))) -- The value to assign to the defined_tags property of this CreateServiceGatewayDetails.
  • display_name (str) -- The value to assign to the display_name property of this CreateServiceGatewayDetails.
  • freeform_tags (dict(str, str)) -- The value to assign to the freeform_tags property of this CreateServiceGatewayDetails.
  • route_table_id (str) -- The value to assign to the route_table_id property of this CreateServiceGatewayDetails.
  • services (list[ServiceIdRequestDetails]) -- The value to assign to the services property of this CreateServiceGatewayDetails.
  • vcn_id (str) -- The value to assign to the vcn_id property of this CreateServiceGatewayDetails.
compartment_id

[Required] Gets the compartment_id of this CreateServiceGatewayDetails. The OCID] of the compartment to contain the service gateway.

Returns:The compartment_id of this CreateServiceGatewayDetails.
Return type:str
defined_tags

Gets the defined_tags of this CreateServiceGatewayDetails. 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 CreateServiceGatewayDetails.
Return type:dict(str, dict(str, object))
display_name

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

Returns:The display_name of this CreateServiceGatewayDetails.
Return type:str
freeform_tags

Gets the freeform_tags of this CreateServiceGatewayDetails. 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 CreateServiceGatewayDetails.
Return type:dict(str, str)
route_table_id

Gets the route_table_id of this CreateServiceGatewayDetails. The OCID of the route table the service gateway will use.

If you don't specify a route table here, the service gateway is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the service gateway.

For information about why you would associate a route table with a service gateway, see Transit Routing: Private Access to Oracle Services.

Returns:The route_table_id of this CreateServiceGatewayDetails.
Return type:str
services

[Required] Gets the services of this CreateServiceGatewayDetails. List of the OCIDs of the Service objects to enable for the service gateway. This list can be empty if you don't want to enable any Service objects when you create the gateway. You can enable a Service object later by using either attach_service_id() or update_service_gateway().

For each enabled Service, make sure there's a route rule with the Service object's cidrBlock as the rule's destination and the service gateway as the rule's target. See RouteTable.

Returns:The services of this CreateServiceGatewayDetails.
Return type:list[ServiceIdRequestDetails]
vcn_id

[Required] Gets the vcn_id of this CreateServiceGatewayDetails. The OCID of the VCN.

Returns:The vcn_id of this CreateServiceGatewayDetails.
Return type:str