AWS::ODB::OdbNetwork - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::ODB::OdbNetwork

The AWS::ODB::OdbNetwork resource creates an ODB network. An ODB network provides the networking foundation for Oracle Database resources.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::ODB::OdbNetwork",
  "Properties" : {
      "AvailabilityZone" : String,
      "AvailabilityZoneId" : String,
      "BackupSubnetCidr" : String,
      "ClientSubnetCidr" : String,
      "DefaultDnsPrefix" : String,
      "DeleteAssociatedResources" : Boolean,
      "DisplayName" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::ODB::OdbNetwork
Properties:
  AvailabilityZone: String
  AvailabilityZoneId: String
  BackupSubnetCidr: String
  ClientSubnetCidr: String
  DefaultDnsPrefix: String
  DeleteAssociatedResources: Boolean
  DisplayName: String
  Tags: 
    - Tag

Properties

AvailabilityZone

The Availability Zone (AZ) where the ODB network is located.

Required when creating an ODB network. Specify either AvailabilityZone or AvailabilityZoneId to define the location of the network.

Required: Conditional

Type: String

Minimum: 1

Maximum: 255

Update requires: Replacement

AvailabilityZoneId

The AZ ID of the AZ where the ODB network is located.

Required when creating an ODB network. Specify either AvailabilityZone or AvailabilityZoneId to define the location of the network.

Required: Conditional

Type: String

Minimum: 1

Maximum: 255

Update requires: Replacement

BackupSubnetCidr

The CIDR range of the backup subnet in the ODB network.

Required: No

Type: String

Minimum: 1

Maximum: 255

Update requires: Replacement

ClientSubnetCidr

The CIDR range of the client subnet in the ODB network.

Required when creating an ODB network.

Required: Conditional

Type: String

Minimum: 1

Maximum: 255

Update requires: Replacement

DefaultDnsPrefix

The DNS prefix to the default DNS domain name. The default DNS domain name is oraclevcn.com.

Required: No

Type: String

Minimum: 1

Maximum: 255

Update requires: Replacement

DeleteAssociatedResources

Specifies whether to delete associated OCI networking resources along with the ODB network.

Required when creating an ODB network.

Required: Conditional

Type: Boolean

Update requires: No interruption

DisplayName

The user-friendly name of the ODB network.

Required when creating an ODB network.

Required: Conditional

Type: String

Pattern: ^[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*$

Minimum: 1

Maximum: 255

Update requires: Replacement

Tags

Tags to assign to the Odb Network.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the unique identifier of the ODB network. For example:

{ "Ref": "myOdbNetwork" }

For the ODB network myOdbNetwork, Ref returns the unique identifier of the ODB network.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

OciNetworkAnchorId

The unique identifier of the OCI network anchor for the ODB network.

OciResourceAnchorName

The name of the OCI resource anchor that's associated with the ODB network.

OciVcnUrl

The URL for the VCN that's associated with the ODB network.

OdbNetworkArn

The Amazon Resource Name (ARN) of the ODB network.

OdbNetworkId

The unique identifier of the ODB network.