ServiceGateway¶

class oci.core.models.ServiceGateway(**kwargs)¶

Bases: object

Represents a router that lets your VCN privately access specific Oracle services such as Object Storage without exposing the VCN to the public internet. Traffic leaving the VCN and destined for a supported Oracle service (see list_services()) is routed through the service gateway and does not traverse the internet. The instances in the VCN do not need to have public IP addresses nor be in a public subnet. The VCN does not need an internet gateway for this traffic. For more information, see Access to Oracle Services: Service Gateway.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

Attributes

`LIFECYCLE_STATE_AVAILABLE`	A constant which can be used with the lifecycle_state property of a ServiceGateway.
`LIFECYCLE_STATE_PROVISIONING`	A constant which can be used with the lifecycle_state property of a ServiceGateway.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a ServiceGateway.
`LIFECYCLE_STATE_TERMINATING`	A constant which can be used with the lifecycle_state property of a ServiceGateway.
`block_traffic`	[Required] Gets the block_traffic of this ServiceGateway.
`compartment_id`	[Required] Gets the compartment_id of this ServiceGateway.
`defined_tags`	Gets the defined_tags of this ServiceGateway.
`display_name`	Gets the display_name of this ServiceGateway.
`freeform_tags`	Gets the freeform_tags of this ServiceGateway.
`id`	[Required] Gets the id of this ServiceGateway.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ServiceGateway.
`route_table_id`	Gets the route_table_id of this ServiceGateway.
`services`	[Required] Gets the services of this ServiceGateway.
`time_created`	Gets the time_created of this ServiceGateway.
`vcn_id`	[Required] Gets the vcn_id of this ServiceGateway.

Methods

__init__(**kwargs) Initializes a new ServiceGateway object with values from keyword arguments.

LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'¶: A constant which can be used with the lifecycle_state property of a ServiceGateway. This constant has a value of “AVAILABLE”

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'¶: A constant which can be used with the lifecycle_state property of a ServiceGateway. This constant has a value of “PROVISIONING”

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'¶: A constant which can be used with the lifecycle_state property of a ServiceGateway. This constant has a value of “TERMINATED”

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'¶: A constant which can be used with the lifecycle_state property of a ServiceGateway. This constant has a value of “TERMINATING”

__init__(**kwargs)¶

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

Parameters:

block_traffic (bool) – The value to assign to the block_traffic property of this ServiceGateway.
compartment_id (str) – The value to assign to the compartment_id property of this ServiceGateway.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ServiceGateway.
display_name (str) – The value to assign to the display_name property of this ServiceGateway.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ServiceGateway.
id (str) – The value to assign to the id property of this ServiceGateway.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ServiceGateway. Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
route_table_id (str) – The value to assign to the route_table_id property of this ServiceGateway.
services (list[oci.core.models.ServiceIdResponseDetails]) – The value to assign to the services property of this ServiceGateway.
time_created (datetime) – The value to assign to the time_created property of this ServiceGateway.
vcn_id (str) – The value to assign to the vcn_id property of this ServiceGateway.

block_traffic¶

[Required] Gets the block_traffic of this ServiceGateway. Whether the service gateway blocks all traffic through it. The default is false. When this is true, traffic is not routed to any services, regardless of route rules.

Example: true

Returns:	The block_traffic of this ServiceGateway.
Return type:	bool

compartment_id¶

[Required] Gets the compartment_id of this ServiceGateway. The OCID of the compartment that contains the service gateway.

Returns:	The compartment_id of this ServiceGateway.
Return type:	str

defined_tags¶

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

display_name¶

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

Returns:	The display_name of this ServiceGateway.
Return type:	str

freeform_tags¶

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

id¶

[Required] Gets the id of this ServiceGateway. The OCID of the service gateway.

Returns:	The id of this ServiceGateway.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this ServiceGateway. The service gateway’s current state.

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

Returns:	The lifecycle_state of this ServiceGateway.
Return type:	str

route_table_id¶

Gets the route_table_id of this ServiceGateway. The OCID of the route table the service gateway is using. 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 ServiceGateway.
Return type:	str

services¶

[Required] Gets the services of this ServiceGateway. List of the Service objects enabled for this service gateway. The list can be empty. You can enable a particular Service by using attach_service_id() or update_service_gateway().

Returns:	The services of this ServiceGateway.
Return type:	list[oci.core.models.ServiceIdResponseDetails]

time_created¶

Gets the time_created of this ServiceGateway. The date and time the service gateway was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_created of this ServiceGateway.
Return type:	datetime

vcn_id¶

[Required] Gets the vcn_id of this ServiceGateway. The OCID of the VCN the service gateway belongs to.

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