Skip to main content

odb_networks

Creates, updates, deletes or gets an odb_network resource or lists odb_networks in a region

Overview​

Nameodb_networks
TypeResource
DescriptionThe AWS::ODB::OdbNetwork resource creates an ODB Network
Idawscc.odb.odb_networks

Fields​

NameDatatypeDescription
availability_zonestringThe AWS 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.
default_dns_prefixstringThe DNS prefix to the default DNS domain name. The default DNS domain name is oraclevcn.com.
delete_associated_resourcesbooleanSpecifies whether to delete associated OCI networking resources along with the ODB network.
display_namestringThe user-friendly name of the ODB network.
oci_network_anchor_idstringThe unique identifier 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_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.
▶tagsarrayTags to assign to the Odb Network.
regionstringAWS region.

For more information, see AWS::ODB::OdbNetwork.

Methods​

NameResourceAccessible byRequired Params
create_resourceodb_networksINSERTregion
delete_resourceodb_networksDELETEIdentifier, region
update_resourceodb_networksUPDATEIdentifier, PatchDocument, region
list_resourcesodb_networks_list_onlySELECTregion
get_resourceodb_networksSELECTIdentifier, region

SELECT examples​

Gets all properties from an individual odb_network.

SELECT
  region,
  availability_zone,
  availability_zone_id,
  backup_subnet_cidr,
  client_subnet_cidr,
  default_dns_prefix,
  delete_associated_resources,
  display_name,
  oci_network_anchor_id,
  oci_resource_anchor_name,
  oci_vcn_url,
  odb_network_arn,
  odb_network_id,
  tags
FROM awscc.odb.odb_networks
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ odb_network_arn }}';

INSERT example​

Use the following StackQL query and manifest file to create a new odb_network resource, using stack-deploy.

/*+ create */
INSERT INTO awscc.odb.odb_networks (
  AvailabilityZone,
  AvailabilityZoneId,
  BackupSubnetCidr,
  ClientSubnetCidr,
  DefaultDnsPrefix,
  DeleteAssociatedResources,
  DisplayName,
  Tags,
  region
)
SELECT
  '{{ availability_zone }}',
  '{{ availability_zone_id }}',
  '{{ backup_subnet_cidr }}',
  '{{ client_subnet_cidr }}',
  '{{ default_dns_prefix }}',
  '{{ delete_associated_resources }}',
  '{{ display_name }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

UPDATE example​

Use the following StackQL query and manifest file to update a odb_network resource, using stack-deploy.

/*+ update */
UPDATE awscc.odb.odb_networks
SET PatchDocument = string('{{ {
    "DeleteAssociatedResources": delete_associated_resources,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ odb_network_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example​

/*+ delete */
DELETE FROM awscc.odb.odb_networks
WHERE
  Identifier = '{{ odb_network_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters​

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

ParameterDescription
ClientToken
A unique identifier to ensure the idempotency of the resource request.This allows the provider to accurately distinguish between retries and new requests.
A client token is valid for 36 hours once used.
After that, a resource request with the same client token is treated as a new request.
If you do not specify a client token, one is generated for inclusion in the request.
RoleArn
The ARN of the IAM role used to perform this resource operation.The role specified must have the permissions required for this operation.
If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId
For private resource types, the type version to use in this resource operation.If you do not specify a resource version, the default version is used.

Permissions​

To operate on the odb_networks resource, the following permissions are required:

odb:CreateOdbNetwork,
odb:TagResource,
ec2:DescribeAvailabilityZones,
iam:CreateServiceLinkedRole,
ec2:DescribeVpcs,
ec2:CreateOdbNetworkPeering,
odb:ListTagsForResource,
sts:GetCallerIdentity,
odb:GetOdbNetwork,
odb:ListOdbNetworks,
odb:UpdateOdbNetwork,
vpc-lattice:CreateServiceNetwork,
vpc-lattice:GetServiceNetwork,
vpc-lattice:CreateServiceNetworkResourceAssociation,
vpc-lattice:GetServiceNetworkResourceAssociation,
vpc-lattice:CreateResourceGateway,
vpc-lattice:GetResourceGateway,
vpc-lattice:CreateServiceNetworkVpcEndpointAssociation,
redshiftchannelmanagement:CreateChannel,
ec2:ModifyOdbNetworkPeering,
ec2:DescribeVpcEndpointAssociations,
ec2:CreateVpcEndpoint,
ec2:DescribeVpcEndpoints,
ec2:CreateTags