AWS Fundamentals Logo
AWS Fundamentals
AWS::ODB::OdbNetwork

ODB OdbNetwork

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

Properties

12 configurable properties. Click a row to see details.

Filter:
PropertyTypeFlags
AvailabilityZone
string
Create-only
AvailabilityZoneId
string
Create-only
BackupSubnetCidr
string
Create-only
ClientSubnetCidr
string
Create-only
CustomDomainName
string
Create-only
DefaultDnsPrefix
string
Create-onlyWrite-only
DeleteAssociatedResources
boolean
Write-only
DisplayName
string
S3Access
string
Write-only
S3PolicyDocument
string
Write-only
Tags
Array<Tag>
ZeroEtlAccess
string
Write-only

Return Values

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

AttributeTypeDescription
ManagedServicesManagedServices-
OciNetworkAnchorIdstringThe unique identifier of the OCI network anchor for the ODB network.
OciResourceAnchorNamestringThe name of the OCI resource anchor that's associated with the ODB network.
OciVcnUrlstringThe URL for the VCN that's associated with the ODB network.
OdbNetworkArnstringThe Amazon Resource Name (ARN) of the ODB network.
OdbNetworkIdstringThe 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:GetCallerIdentity

read

odb:GetOdbNetworkodb:ListOdbNetworksodb:ListTagsForResourcests:GetCallerIdentityvpc-lattice:GetServiceNetworkvpc-lattice:GetServiceNetworkResourceAssociationvpc-lattice:GetResourceGatewayec2:DescribeVpcEndpointAssociations

update

odb:UpdateOdbNetworkodb:TagResourceodb:UntagResourceec2:DescribeVpcsec2:CreateOdbNetworkPeeringec2:DeleteOdbNetworkPeeringodb:ListTagsForResourcests:GetCallerIdentity

delete

odb:DeleteOdbNetworkec2:DeleteOdbNetworkPeeringec2:DescribeVpcsodb:ListTagsForResourcests:GetCallerIdentityodb:GetOdbNetworkodb:ListOdbNetworksvpc-lattice:DeleteServiceNetwork

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
Properties18
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