odb_networks

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

Overview

Name	odb_networks
Type	Resource
Description	The AWS::ODB::OdbNetwork resource creates an ODB Network
Id	awscc.odb.odb_networks

Fields

Name	Datatype	Description
availability_zone	string	The AWS Availability Zone (AZ) where the ODB network is located.
availability_zone_id	string	The AZ ID of the AZ where the ODB network is located.
backup_subnet_cidr	string	The CIDR range of the backup subnet in the ODB network.
client_subnet_cidr	string	The CIDR range of the client subnet in the ODB network.
default_dns_prefix	string	The DNS prefix to the default DNS domain name. The default DNS domain name is oraclevcn.com.
delete_associated_resources	boolean	Specifies whether to delete associated OCI networking resources along with the ODB network.
display_name	string	The user-friendly name of the ODB network.
oci_network_anchor_id	string	The unique identifier of the OCI network anchor for the ODB network.
oci_resource_anchor_name	string	The name of the OCI resource anchor that's associated with the ODB network.
oci_vcn_url	string	The URL for the VCN that's associated with the ODB network.
odb_network_arn	string	The Amazon Resource Name (ARN) of the ODB network.
odb_network_id	string	The unique identifier of the ODB network.
▶tags	array	Tags to assign to the Odb Network.
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, 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 = 'us-east-1' AND data__Identifier = '<OdbNetworkArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.odb.odb_networks (
 AvailabilityZone,
 AvailabilityZoneId,
 BackupSubnetCidr,
 ClientSubnetCidr,
 DefaultDnsPrefix,
 DeleteAssociatedResources,
 DisplayName,
 Tags,
 region
)
SELECT 
'{{ AvailabilityZone }}',
 '{{ AvailabilityZoneId }}',
 '{{ BackupSubnetCidr }}',
 '{{ ClientSubnetCidr }}',
 '{{ DefaultDnsPrefix }}',
 '{{ DeleteAssociatedResources }}',
 '{{ DisplayName }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.odb.odb_networks (
 AvailabilityZone,
 AvailabilityZoneId,
 BackupSubnetCidr,
 ClientSubnetCidr,
 DefaultDnsPrefix,
 DeleteAssociatedResources,
 DisplayName,
 Tags,
 region
)
SELECT 
 '{{ AvailabilityZone }}',
 '{{ AvailabilityZoneId }}',
 '{{ BackupSubnetCidr }}',
 '{{ ClientSubnetCidr }}',
 '{{ DefaultDnsPrefix }}',
 '{{ DeleteAssociatedResources }}',
 '{{ DisplayName }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: odb_network
    props:
      - name: AvailabilityZone
        value: '{{ AvailabilityZone }}'
      - name: AvailabilityZoneId
        value: '{{ AvailabilityZoneId }}'
      - name: BackupSubnetCidr
        value: '{{ BackupSubnetCidr }}'
      - name: ClientSubnetCidr
        value: '{{ ClientSubnetCidr }}'
      - name: DefaultDnsPrefix
        value: '{{ DefaultDnsPrefix }}'
      - name: DeleteAssociatedResources
        value: '{{ DeleteAssociatedResources }}'
      - name: DisplayName
        value: '{{ DisplayName }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM awscc.odb.odb_networks
WHERE data__Identifier = '<OdbNetworkArn>'
AND region = 'us-east-1';

Permissions

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

Create

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

Read

odb:GetOdbNetwork,
odb:ListOdbNetworks,
odb:ListTagsForResource,
sts:GetCallerIdentity,
vpc-lattice:GetServiceNetwork,
vpc-lattice:GetServiceNetworkResourceAssociation,
vpc-lattice:GetResourceGateway,
ec2:DescribeVpcEndpointAssociations,
ec2:DescribeVpcEndpoints

Update

odb:UpdateOdbNetwork,
odb:TagResource,
odb:UntagResource,
ec2:DescribeVpcs,
ec2:CreateOdbNetworkPeering,
ec2:DeleteOdbNetworkPeering,
odb:ListTagsForResource,
sts:GetCallerIdentity,
odb:GetOdbNetwork,
odb:ListOdbNetworks,
vpc-lattice:GetServiceNetwork,
vpc-lattice:GetServiceNetworkResourceAssociation,
vpc-lattice:GetResourceGateway,
ec2:DescribeVpcEndpointAssociations,
ec2:DescribeVpcEndpoints

Delete

odb:DeleteOdbNetwork,
ec2:DeleteOdbNetworkPeering,
ec2:DescribeVpcs,
odb:ListTagsForResource,
sts:GetCallerIdentity,
odb:GetOdbNetwork,
odb:ListOdbNetworks,
vpc-lattice:DeleteServiceNetwork,
vpc-lattice:GetServiceNetwork,
vpc-lattice:DeleteServiceNetworkResourceAssociation,
vpc-lattice:GetServiceNetworkResourceAssociation,
vpc-lattice:DeleteResourceGateway,
vpc-lattice:GetResourceGateway,
ec2:ModifyOdbNetworkPeering,
ec2:DescribeVpcEndpointAssociations,
ec2:DeleteVpcEndpoints,
ec2:DescribeVpcEndpoints

List

odb:ListOdbNetworks,
odb:ListTagsForResource,
sts:GetCallerIdentity,
vpc-lattice:GetServiceNetwork,
vpc-lattice:GetServiceNetworkResourceAssociation,
vpc-lattice:GetResourceGateway,
ec2:DescribeVpcEndpointAssociations,
ec2:DescribeVpcEndpoints