odb_peering_connections

Creates, updates, deletes, gets or lists an odb_peering_connections resource.

Overview

Name	odb_peering_connections
Type	Resource
Id	aws.odb.odb_peering_connections

Fields

The following fields are returned by SELECT queries:

get_odb_peering_connection

Name	Datatype	Description
created_at	string (date-time)	The timestamp when the ODB peering connection was created.
display_name	string	The display name of the ODB peering connection.
odb_network_arn	string	The Amazon Resource Name (ARN) of the ODB network that initiated the peering connection.
odb_peering_connection_arn	string	The Amazon Resource Name (ARN) of the ODB peering connection. Example: arn:aws:odb:us-east-1:123456789012:odb-peering-connection/odbpcx-abcdefgh12345678
odb_peering_connection_id	string	The unique identifier of the ODB peering connection. A sample ID is odbpcx-abcdefgh12345678. (pattern: <code>(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_.-]{6,64}|[a-zA-Z0-9_.-]{6,64})</code>)
odb_peering_connection_type	string	The type of the ODB peering connection. Valid Values: ODB-VPC | ODB-ODB
peer_network_arn	string	The Amazon Resource Name (ARN) of the peer network.
peer_network_cidrs	array	The CIDR blocks associated with the peering connection. These CIDR blocks define the IP address ranges that can communicate through the peering connection.
percent_progress	number (float)	The percentage progress of the ODB peering connection creation or deletion.
status	string	The status of the ODB peering connection. (AVAILABLE, FAILED, PROVISIONING, TERMINATED, TERMINATING, UPDATING, MAINTENANCE_IN_PROGRESS)
status_reason	string	The reason for the current status of the ODB peering connection.

list_odb_peering_connections

Name	Datatype	Description
created_at	string (date-time)	The timestamp when the ODB peering connection was created.
display_name	string	The display name of the ODB peering connection.
odb_network_arn	string	The Amazon Resource Name (ARN) of the ODB network that initiated the peering connection.
odb_peering_connection_arn	string	The Amazon Resource Name (ARN) of the ODB peering connection.
odb_peering_connection_id	string	The unique identifier of the ODB peering connection. A sample ID is odbpcx-abcdefgh12345678. (pattern: <code>(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_.-]{6,64}|[a-zA-Z0-9_.-]{6,64})</code>)
odb_peering_connection_type	string	The type of the ODB peering connection. Valid Values: ODB-VPC | ODB-ODB
peer_network_arn	string	The Amazon Resource Name (ARN) of the peer network.
peer_network_cidrs	array	The CIDR blocks associated with the peering connection. These CIDR blocks define the IP address ranges that can communicate through the peering connection.
percent_progress	number (float)	The percentage progress of the ODB peering connection creation or deletion.
status	string	The status of the ODB peering connection. (AVAILABLE, FAILED, PROVISIONING, TERMINATED, TERMINATING, UPDATING, MAINTENANCE_IN_PROGRESS)
status_reason	string	The reason for the current status of the ODB peering connection.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_odb_peering_connection	select	region		Retrieves information about an ODB peering connection.
list_odb_peering_connections	select	region		Lists all ODB peering connections or those associated with a specific ODB network.
create_odb_peering_connection	insert	region, odbNetworkId, peerNetworkId		Creates a peering connection between an ODB network and a VPC. A peering connection enables private connectivity between the networks for application-tier communication.
update_odb_peering_connection	update	region, odbPeeringConnectionId		Modifies the settings of an Oracle Database@Amazon Web Services peering connection. You can update the display name and add or remove CIDR blocks from the peering connection.
delete_odb_peering_connection	delete	region		Deletes an ODB peering connection. When you delete an ODB peering connection, the underlying VPC peering connection is also deleted.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_odb_peering_connection

Retrieves information about an ODB peering connection.

SELECT
created_at,
display_name,
odb_network_arn,
odb_peering_connection_arn,
odb_peering_connection_id,
odb_peering_connection_type,
peer_network_arn,
peer_network_cidrs,
percent_progress,
status,
status_reason
FROM aws.odb.odb_peering_connections
WHERE region = '{{ region }}' -- required
;

list_odb_peering_connections

Lists all ODB peering connections or those associated with a specific ODB network.

SELECT
created_at,
display_name,
odb_network_arn,
odb_peering_connection_arn,
odb_peering_connection_id,
odb_peering_connection_type,
peer_network_arn,
peer_network_cidrs,
percent_progress,
status,
status_reason
FROM aws.odb.odb_peering_connections
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_odb_peering_connection

Creates a peering connection between an ODB network and a VPC. A peering connection enables private connectivity between the networks for application-tier communication.

INSERT INTO aws.odb.odb_peering_connections (
odbNetworkId,
peerNetworkId,
displayName,
peerNetworkCidrsToBeAdded,
peerNetworkRouteTableIds,
clientToken,
tags,
region
)
SELECT 
'{{ odbNetworkId }}' /* required */,
'{{ peerNetworkId }}' /* required */,
'{{ displayName }}',
'{{ peerNetworkCidrsToBeAdded }}',
'{{ peerNetworkRouteTableIds }}',
'{{ clientToken }}',
'{{ tags }}',
'{{ region }}'
RETURNING
display_name,
odb_peering_connection_id,
status,
status_reason
;

Manifest

# Description fields are for documentation purposes
- name: odb_peering_connections
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the odb_peering_connections resource.
  - name: odbNetworkId
    value: "{{ odbNetworkId }}"
    description: |
      The unique identifier of the ODB network that initiates the peering connection.
  - name: peerNetworkId
    value: "{{ peerNetworkId }}"
    description: |
      The unique identifier of the peer network. This can be either a VPC ID or another ODB network ID.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The display name for the ODB peering connection.
  - name: peerNetworkCidrsToBeAdded
    value:
      - "{{ peerNetworkCidrsToBeAdded }}"
    description: |
      A list of CIDR blocks to add to the peering connection. These CIDR blocks define the IP address ranges that can communicate through the peering connection.
  - name: peerNetworkRouteTableIds
    value:
      - "{{ peerNetworkRouteTableIds }}"
    description: |
      The unique identifier of the VPC route table for which a route to the ODB network is automatically created during peering connection establishment.
  - name: clientToken
    value: "{{ clientToken }}"
    description: |
      The client token for the ODB peering connection request. Constraints: Must be unique for each request.
  - name: tags
    value: "{{ tags }}"
    description: |
      The tags to assign to the ODB peering connection.

UPDATE examples

update_odb_peering_connection

Modifies the settings of an Oracle Database@Amazon Web Services peering connection. You can update the display name and add or remove CIDR blocks from the peering connection.

UPDATE aws.odb.odb_peering_connections
SET 
odbPeeringConnectionId = '{{ odbPeeringConnectionId }}',
displayName = '{{ displayName }}',
peerNetworkCidrsToBeAdded = '{{ peerNetworkCidrsToBeAdded }}',
peerNetworkCidrsToBeRemoved = '{{ peerNetworkCidrsToBeRemoved }}'
WHERE 
region = '{{ region }}' --required
AND odbPeeringConnectionId = '{{ odbPeeringConnectionId }}' --required
RETURNING
display_name,
odb_peering_connection_id,
status,
status_reason;

DELETE examples

delete_odb_peering_connection

Deletes an ODB peering connection. When you delete an ODB peering connection, the underlying VPC peering connection is also deleted.

DELETE FROM aws.odb.odb_peering_connections
WHERE region = '{{ region }}' --required
;