InternetGateway

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

Bases: object

Represents a router that connects the edge of a VCN with the Internet. For an example scenario that uses an internet gateway, see Typical Networking Service Scenarios.

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.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'

A constant which can be used with the lifecycle_state property of a InternetGateway. This constant has a value of "AVAILABLE"

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'

A constant which can be used with the lifecycle_state property of a InternetGateway. This constant has a value of "PROVISIONING"

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'

A constant which can be used with the lifecycle_state property of a InternetGateway. This constant has a value of "TERMINATED"

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'

A constant which can be used with the lifecycle_state property of a InternetGateway. This constant has a value of "TERMINATING"

__init__(**kwargs)

Initializes a new InternetGateway 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 InternetGateway.
  • defined_tags (dict(str, dict(str, object))) -- The value to assign to the defined_tags property of this InternetGateway.
  • display_name (str) -- The value to assign to the display_name property of this InternetGateway.
  • freeform_tags (dict(str, str)) -- The value to assign to the freeform_tags property of this InternetGateway.
  • id (str) -- The value to assign to the id property of this InternetGateway.
  • is_enabled (bool) -- The value to assign to the is_enabled property of this InternetGateway.
  • lifecycle_state (str) -- The value to assign to the lifecycle_state property of this InternetGateway. 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'.
  • time_created (datetime) -- The value to assign to the time_created property of this InternetGateway.
  • vcn_id (str) -- The value to assign to the vcn_id property of this InternetGateway.
compartment_id

[Required] Gets the compartment_id of this InternetGateway. The OCID of the compartment containing the internet gateway.

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

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

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

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

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

[Required] Gets the id of this InternetGateway. The internet gateway's Oracle ID (OCID).

Returns:The id of this InternetGateway.
Return type:str
is_enabled

Gets the is_enabled of this InternetGateway. Whether the gateway is enabled. When the gateway is disabled, traffic is not routed to/from the Internet, regardless of route rules.

Returns:The is_enabled of this InternetGateway.
Return type:bool
lifecycle_state

[Required] Gets the lifecycle_state of this InternetGateway. The internet 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 InternetGateway.
Return type:str
time_created

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

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

Returns:The time_created of this InternetGateway.
Return type:datetime
vcn_id

[Required] Gets the vcn_id of this InternetGateway. The OCID of the VCN the internet gateway belongs to.

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