Data Source: oci_apigateway_gateway

This data source provides details about a specific Gateway resource in Oracle Cloud Infrastructure API Gateway service.

Gets a gateway by identifier.

Example Usage

data "oci_apigateway_gateway" "test_gateway" {
	#Required
	gateway_id = oci_apigateway_gateway.test_gateway.id
}

Argument Reference

The following arguments are supported:

• gateway_id - (Required) The ocid of the gateway.

Attributes Reference

The following attributes are exported:

• ca_bundles - An array of CA bundles that should be used on the Gateway for TLS validation.
  • ca_bundle_id - The OCID of the resource.
  • certificate_authority_id - The OCID of the resource.
  • type - Type of the CA bundle
• certificate_id - The OCID of the resource.
• compartment_id - The OCID of the compartment in which the resource is created.
• defined_tags - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
• display_name - A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information. Example: My new resource
• endpoint_type - 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
• freeform_tags - 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"}
• hostname - The hostname for APIs deployed on the gateway.
• id - The OCID of the resource.
• ip_addresses - An array of IP addresses associated with the gateway.
  • ip_address - An IP address.
• ip_mode - Determines whether the gateway has an IPv4 or IPv6 address assigned to it, or both. IPV4 means the gateway will only have an IPv4 address assigned to it, and IPV6 means the gateway will only have an IPv6 address assigned to it. DUAL_STACK means the gateway will have both an IPv4 and IPv6 address assigned to it. Example: IPV4 or IPV6 or DUAL_STACK
• ipv4address_configuration - IPv4 address configuration details that should be used when creating the gateway.
  • reserved_ip_ids - List of Reserved IP OCIDs created in VCN service.
• ipv6address_configuration - IPv6 address configuration details that should be used when creating the gateway.
  • addresses - List of IPv6 addresses that will be assigned to the gateway during creation.
  • subnet_cidrs - List of IPv6 prefixes from which to provision IPv6 addresses from. This is required if more than one prefix exists on the subnet.
• lifecycle_details - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
• locks - Locks associated with this resource.
  • message - A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
  • related_resource_id - The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
  • time_created - When the lock was created.
  • type - Type of the lock.
• network_security_group_ids - An array of Network Security Groups OCIDs associated with this API Gateway.
• response_cache_details - Base Gateway response cache.
  • authentication_secret_id - The OCID of the Oracle Vault Service secret resource.
  • authentication_secret_version_number - The version number of the authentication secret to use.
  • connect_timeout_in_ms - Defines the timeout for establishing a connection with the Response Cache.
  • is_ssl_enabled - Defines if the connection should be over SSL.
  • is_ssl_verify_disabled - Defines whether or not to uphold SSL verification.
  • read_timeout_in_ms - Defines the timeout for reading data from the Response Cache.
  • send_timeout_in_ms - Defines the timeout for transmitting data to the Response Cache.
  • servers - The set of cache store members to connect to. At present only a single server is supported.
    • host - Hostname or IP address (IPv4 only) where the cache store is running.
    • port - The port the cache store is exposed on.
  • type - Type of the Response Cache.
• state - The current state of the gateway.
• subnet_id - The OCID of the subnet in which related resources are created.
• system_tags - System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
• time_created - The time this resource was created. An RFC3339 formatted datetime string.
• time_updated - The time this resource was last updated. An RFC3339 formatted datetime string.