NatGateway¶

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

Bases: object

A NAT (Network Address Translation) gateway, which represents a router that lets instances without public IPs contact the public internet without exposing the instance to inbound internet traffic. For more information, see NAT Gateway.

To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are 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 NatGateway.
`LIFECYCLE_STATE_PROVISIONING`	A constant which can be used with the lifecycle_state property of a NatGateway.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a NatGateway.
`LIFECYCLE_STATE_TERMINATING`	A constant which can be used with the lifecycle_state property of a NatGateway.
`block_traffic`	[Required] Gets the block_traffic of this NatGateway.
`compartment_id`	[Required] Gets the compartment_id of this NatGateway.
`defined_tags`	Gets the defined_tags of this NatGateway.
`display_name`	Gets the display_name of this NatGateway.
`freeform_tags`	Gets the freeform_tags of this NatGateway.
`id`	[Required] Gets the id of this NatGateway.
`lifecycle_state`	[Required] Gets the lifecycle_state of this NatGateway.
`nat_ip`	[Required] Gets the nat_ip of this NatGateway.
`public_ip_id`	Gets the public_ip_id of this NatGateway.
`route_table_id`	Gets the route_table_id of this NatGateway.
`time_created`	[Required] Gets the time_created of this NatGateway.
`vcn_id`	[Required] Gets the vcn_id of this NatGateway.

Methods

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new NatGateway 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 NatGateway.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this NatGateway.
display_name (str) – The value to assign to the display_name property of this NatGateway.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this NatGateway.
id (str) – The value to assign to the id property of this NatGateway.
block_traffic (bool) – The value to assign to the block_traffic property of this NatGateway.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this NatGateway. 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’.
nat_ip (str) – The value to assign to the nat_ip property of this NatGateway.
time_created (datetime) – The value to assign to the time_created property of this NatGateway.
vcn_id (str) – The value to assign to the vcn_id property of this NatGateway.
public_ip_id (str) – The value to assign to the public_ip_id property of this NatGateway.
route_table_id (str) – The value to assign to the route_table_id property of this NatGateway.

block_traffic¶

[Required] Gets the block_traffic of this NatGateway. Whether the NAT gateway blocks traffic through it. The default is false.

Example: true

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

compartment_id¶

[Required] Gets the compartment_id of this NatGateway. The OCID of the compartment that contains the NAT gateway.

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

defined_tags¶

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

display_name¶

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

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

freeform_tags¶

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

id¶

[Required] Gets the id of this NatGateway. The OCID of the NAT gateway.

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

lifecycle_state¶

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

nat_ip¶

[Required] Gets the nat_ip of this NatGateway. The IP address associated with the NAT gateway.

Returns:	The nat_ip of this NatGateway.
Return type:	str

public_ip_id¶

Gets the public_ip_id of this NatGateway. The OCID of the public IP address associated with the NAT gateway.

Returns:	The public_ip_id of this NatGateway.
Return type:	str

route_table_id¶

Gets the route_table_id of this NatGateway. The OCID of the route table used by the NAT gateway.

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

Returns:	The route_table_id of this NatGateway.
Return type:	str

time_created¶

[Required] Gets the time_created of this NatGateway. The date and time the NAT gateway was created, in the format defined by RFC3339.

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

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

vcn_id¶

[Required] Gets the vcn_id of this NatGateway. The OCID of the VCN the NAT gateway belongs to.

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