Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1466450398.1 KB

Creates an ODB network.

post/#X-Amz-Target=Odb.CreateOdbNetwork

Headers

X-Amz-Target'Odb.CreateOdbNetwork' required

Request body

displayNamestring required

A user-friendly name for the ODB network.

availabilityZonestring
<p>The Amazon Web Services Availability Zone (AZ) where the ODB network is located.</p> <p>This operation requires that you specify a value for either <code>availabilityZone</code> or <code>availabilityZoneId</code>.</p>
availabilityZoneIdstring
<p>The AZ ID of the AZ where the ODB network is located.</p> <p>This operation requires that you specify a value for either <code>availabilityZone</code> or <code>availabilityZoneId</code>.</p>
clientSubnetCidrstring required
<p>The CIDR range of the client subnet for the ODB network.</p> <p>Constraints:</p> <ul> <li> <p>Must not overlap with the CIDR range of the backup subnet.</p> </li> <li> <p>Must not overlap with the CIDR ranges of the VPCs that are connected to the ODB network.</p> </li> <li> <p>Must not use the following CIDR ranges that are reserved by OCI:</p> <ul> <li> <p> <code>100.106.0.0/16</code> and <code>100.107.0.0/16</code> </p> </li> <li> <p> <code>169.254.0.0/16</code> </p> </li> <li> <p> <code>224.0.0.0 - 239.255.255.255</code> </p> </li> <li> <p> <code>240.0.0.0 - 255.255.255.255</code> </p> </li> </ul> </li> </ul>
backupSubnetCidrstring
<p>The CIDR range of the backup subnet for the ODB network.</p> <p>Constraints:</p> <ul> <li> <p>Must not overlap with the CIDR range of the client subnet.</p> </li> <li> <p>Must not overlap with the CIDR ranges of the VPCs that are connected to the ODB network.</p> </li> <li> <p>Must not use the following CIDR ranges that are reserved by OCI:</p> <ul> <li> <p> <code>100.106.0.0/16</code> and <code>100.107.0.0/16</code> </p> </li> <li> <p> <code>169.254.0.0/16</code> </p> </li> <li> <p> <code>224.0.0.0 - 239.255.255.255</code> </p> </li> <li> <p> <code>240.0.0.0 - 255.255.255.255</code> </p> </li> </ul> </li> </ul>
customDomainNamestring

The domain name to use for the resources in the ODB network.

defaultDnsPrefixstring

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

clientTokenstring

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency. The client token is valid for up to 24 hours after it's first used.

s3Access'ENABLED' | 'DISABLED'

Specifies the configuration for Amazon S3 access from the ODB network.

zeroEtlAccess'ENABLED' | 'DISABLED'

Specifies the configuration for Zero-ETL access from the ODB network.

stsAccess'ENABLED' | 'DISABLED'

The Amazon Web Services Security Token Service (STS) access configuration for the ODB network.

kmsAccess'ENABLED' | 'DISABLED'

The Amazon Web Services Key Management Service (KMS) access configuration for the ODB network.

s3PolicyDocumentstring

Specifies the endpoint policy for Amazon S3 access from the ODB network.

stsPolicyDocumentstring

The Amazon Web Services Security Token Service (STS) policy document that defines permissions for token service usage within the ODB network.

kmsPolicyDocumentstring

The Amazon Web Services Key Management Service (KMS) policy document that defines permissions for key usage within the ODB network.

crossRegionS3RestoreSourcesToEnableString[]

The cross-Region Amazon S3 restore sources to enable for the ODB network.

tagsobject

The list of resource tags to apply to the ODB network.

Response

Success

displayNamestring

The user-friendly name of the ODB network.

status'AVAILABLE' | 'FAILED' | 'PROVISIONING' | 'TERMINATED' | 'TERMINATING' | 'UPDATING' | 'MAINTENANCE_IN_PROGRESS'

The current status of the ODB network.

statusReasonstring

Additional information about the status of the ODB network.

odbNetworkIdstring required

The unique identifier of the ODB network.