AWS::ODB::OdbNetwork

ODB OdbNetwork

The AWS::ODB::OdbNetwork resource creates an ODB Network

Properties

17 configurable properties. Click a row to see details.

Filter:

Property	Type	Flags
`AvailabilityZone`	`string`	Create-only
`AvailabilityZoneId`	`string`	Create-only
`BackupSubnetCidr`	`string`	Create-only
`ClientSubnetCidr`	`string`	Create-only
`CrossRegionS3RestoreSources`	`Array<string>`	Write-only
`CustomDomainName`	`string`	Create-only
`DefaultDnsPrefix`	`string`	Create-onlyWrite-only
`DeleteAssociatedResources`	`boolean`	Write-only
`DisplayName`	`string`
`KmsAccess`	`string`	Write-only
`KmsPolicyDocument`	`string`	Write-only
`S3Access`	`string`	Write-only
`S3PolicyDocument`	`string`	Write-only
`StsAccess`	`string`	Write-only
`StsPolicyDocument`	`string`	Write-only
`Tags`	`Array<Tag>`
`ZeroEtlAccess`	`string`	Write-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`ManagedServices`	`ManagedServices`	-
`OciNetworkAnchorId`	`string`	The unique identifier of the OCI network anchor for the ODB network.
`OciResourceAnchorName`	`string`	The name of the OCI resource anchor that's associated with the ODB network.
`OciVcnUrl`	`string`	The URL for the VCN that's associated with the ODB network.
`OdbNetworkArn`	`string`	The Amazon Resource Name (ARN) of the ODB network.
`OdbNetworkId`	`string`	The unique identifier of the ODB network.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::ODB::OdbNetwork

Resources:
  MyResource:
    Type: AWS::ODB::OdbNetwork
    Properties:
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

odb:CreateOdbNetworkodb:TagResourceec2:DescribeAvailabilityZonesiam:CreateServiceLinkedRoleec2:DescribeVpcsec2:CreateOdbNetworkPeeringodb:ListTagsForResourcests:GetCallerIdentityodb:GetOdbNetworkodb:ListOdbNetworksodb:UpdateOdbNetworkvpc-lattice:CreateServiceNetworkvpc-lattice:GetServiceNetworkvpc-lattice:CreateServiceNetworkResourceAssociationvpc-lattice:GetServiceNetworkResourceAssociationvpc-lattice:CreateResourceGatewayvpc-lattice:GetResourceGatewayvpc-lattice:CreateServiceNetworkVpcEndpointAssociationredshiftchannelmanagement:CreateChannelec2:ModifyOdbNetworkPeeringec2:DescribeVpcEndpointAssociationsec2:CreateVpcEndpointec2:DescribeVpcEndpointsec2:CreateTags

read

odb:GetOdbNetworkodb:ListOdbNetworksodb:ListTagsForResourcests:GetCallerIdentityvpc-lattice:GetServiceNetworkvpc-lattice:GetServiceNetworkResourceAssociationvpc-lattice:GetResourceGatewayec2:DescribeVpcEndpointAssociationsec2:DescribeVpcEndpoints

update

odb:UpdateOdbNetworkodb:TagResourceodb:UntagResourceec2:DescribeVpcsec2:CreateOdbNetworkPeeringec2:DeleteOdbNetworkPeeringodb:ListTagsForResourcests:GetCallerIdentityodb:GetOdbNetworkodb:ListOdbNetworksvpc-lattice:CreateServiceNetworkResourceAssociationvpc-lattice:DeleteServiceNetworkResourceAssociationvpc-lattice:GetServiceNetworkvpc-lattice:GetServiceNetworkResourceAssociationvpc-lattice:GetResourceGatewayec2:DescribeVpcEndpointAssociationsec2:DescribeVpcEndpoints

delete

odb:DeleteOdbNetworkec2:DeleteOdbNetworkPeeringec2:DescribeVpcsodb:ListTagsForResourcests:GetCallerIdentityodb:GetOdbNetworkodb:ListOdbNetworksvpc-lattice:DeleteServiceNetworkvpc-lattice:GetServiceNetworkvpc-lattice:DeleteServiceNetworkResourceAssociationvpc-lattice:GetServiceNetworkResourceAssociationvpc-lattice:DeleteResourceGatewayvpc-lattice:GetResourceGatewayec2:ModifyOdbNetworkPeeringec2:DescribeVpcEndpointAssociationsec2:DeleteVpcEndpointsec2:DescribeVpcEndpoints

list

odb:ListOdbNetworksodb:ListTagsForResourcests:GetCallerIdentityvpc-lattice:GetServiceNetworkvpc-lattice:GetServiceNetworkResourceAssociationvpc-lattice:GetResourceGatewayec2:DescribeVpcEndpointAssociationsec2:DescribeVpcEndpoints

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceODB

Properties23

Required0

TaggingSupported

Primary IDOdbNetworkArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

AvailabilityZoneAvailabilityZoneIdBackupSubnetCidrClientSubnetCidrCustomDomainNameDefaultDnsPrefix

Related Resources

External Links

AWS Documentation