Skip to main content

odb_networks

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

Overview​

Nameodb_networks
TypeResource
Idaws.odb.odb_networks

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
availability_zonestringThe Amazon Web Services Availability Zone (AZ) where the ODB network is located.
availability_zone_idstringThe AZ ID of the AZ where the ODB network is located.
backup_subnet_cidrstringThe CIDR range of the backup subnet in the ODB network.
client_subnet_cidrstringThe CIDR range of the client subnet in the ODB network.
created_atstring (date-time)The date and time when the ODB network was created.
custom_domain_namestringThe domain name for the resources in the ODB network.
default_dns_prefixstringThe DNS prefix to the default DNS domain name. The default DNS domain name is oraclevcn.com.
display_namestringThe user-friendly name of the ODB network.
ec_2_placement_group_idsarrayThe list of EC2 Placement Group IDs associated with your ODB network.
managed_servicesobjectThe managed services configuration for the ODB network.
oci_dns_forwarding_configsarrayThe DNS resolver endpoint in OCI for forwarding DNS queries for the ociPrivateZone domain.
oci_network_anchor_idstringThe unique identifier of the OCI network anchor for the ODB network.
oci_network_anchor_urlstringThe URL of the OCI network anchor for the ODB network.
oci_resource_anchor_namestringThe name of the OCI resource anchor that's associated with the ODB network.
oci_vcn_idstringThe Oracle Cloud ID (OCID) for the Virtual Cloud Network (VCN) that's associated with the ODB network.
oci_vcn_urlstringThe URL for the VCN that's associated with the ODB network.
odb_network_arnstringThe Amazon Resource Name (ARN) of the ODB network.
odb_network_idstringThe unique identifier of the ODB network. (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>)
peered_cidrsarrayThe list of CIDR ranges from the peered VPC that are allowed access to the ODB network.
percent_progressnumber (float)The amount of progress made on the current operation on the ODB network, expressed as a percentage.
statusstringThe current status of the ODB network. (AVAILABLE, FAILED, PROVISIONING, TERMINATED, TERMINATING, UPDATING, MAINTENANCE_IN_PROGRESS)
status_reasonstringAdditional information about the current status of the ODB network.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_odb_networkselectregionReturns information about the specified ODB network.
list_odb_networksselectregionReturns information about the ODB networks owned by your Amazon Web Services account.
create_odb_networkinsertregion, displayName, clientSubnetCidrCreates an ODB network.
update_odb_networkupdateregion, odbNetworkIdUpdates properties of a specified ODB network.
delete_odb_networkdeleteregionDeletes the specified ODB network.

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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples​

Returns information about the specified ODB network.

SELECT
availability_zone,
availability_zone_id,
backup_subnet_cidr,
client_subnet_cidr,
created_at,
custom_domain_name,
default_dns_prefix,
display_name,
ec_2_placement_group_ids,
managed_services,
oci_dns_forwarding_configs,
oci_network_anchor_id,
oci_network_anchor_url,
oci_resource_anchor_name,
oci_vcn_id,
oci_vcn_url,
odb_network_arn,
odb_network_id,
peered_cidrs,
percent_progress,
status,
status_reason
FROM aws.odb.odb_networks
WHERE region = '{{ region }}' -- required
;

INSERT examples​

Creates an ODB network.

INSERT INTO aws.odb.odb_networks (
displayName,
availabilityZone,
availabilityZoneId,
clientSubnetCidr,
backupSubnetCidr,
customDomainName,
defaultDnsPrefix,
clientToken,
s3Access,
zeroEtlAccess,
stsAccess,
kmsAccess,
s3PolicyDocument,
stsPolicyDocument,
kmsPolicyDocument,
crossRegionS3RestoreSourcesToEnable,
tags,
region
)
SELECT 
'{{ displayName }}' /* required */,
'{{ availabilityZone }}',
'{{ availabilityZoneId }}',
'{{ clientSubnetCidr }}' /* required */,
'{{ backupSubnetCidr }}',
'{{ customDomainName }}',
'{{ defaultDnsPrefix }}',
'{{ clientToken }}',
'{{ s3Access }}',
'{{ zeroEtlAccess }}',
'{{ stsAccess }}',
'{{ kmsAccess }}',
'{{ s3PolicyDocument }}',
'{{ stsPolicyDocument }}',
'{{ kmsPolicyDocument }}',
'{{ crossRegionS3RestoreSourcesToEnable }}',
'{{ tags }}',
'{{ region }}'
RETURNING
display_name,
odb_network_id,
status,
status_reason
;

UPDATE examples​

Updates properties of a specified ODB network.

UPDATE aws.odb.odb_networks
SET 
odbNetworkId = '{{ odbNetworkId }}',
displayName = '{{ displayName }}',
peeredCidrsToBeAdded = '{{ peeredCidrsToBeAdded }}',
peeredCidrsToBeRemoved = '{{ peeredCidrsToBeRemoved }}',
s3Access = '{{ s3Access }}',
zeroEtlAccess = '{{ zeroEtlAccess }}',
stsAccess = '{{ stsAccess }}',
kmsAccess = '{{ kmsAccess }}',
s3PolicyDocument = '{{ s3PolicyDocument }}',
stsPolicyDocument = '{{ stsPolicyDocument }}',
kmsPolicyDocument = '{{ kmsPolicyDocument }}',
crossRegionS3RestoreSourcesToEnable = '{{ crossRegionS3RestoreSourcesToEnable }}',
crossRegionS3RestoreSourcesToDisable = '{{ crossRegionS3RestoreSourcesToDisable }}'
WHERE 
region = '{{ region }}' --required
AND odbNetworkId = '{{ odbNetworkId }}' --required
RETURNING
display_name,
odb_network_id,
status,
status_reason;

DELETE examples​

Deletes the specified ODB network.

DELETE FROM aws.odb.odb_networks
WHERE region = '{{ region }}' --required
;
Last updated on