CreateOdbNetwork - Oracle Database@AWS
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also

CreateOdbNetwork

Creates an ODB network.

Request Syntax

{
   "availabilityZone": "string",
   "availabilityZoneId": "string",
   "backupSubnetCidr": "string",
   "clientSubnetCidr": "string",
   "clientToken": "string",
   "customDomainName": "string",
   "defaultDnsPrefix": "string",
   "displayName": "string",
   "s3Access": "string",
   "s3PolicyDocument": "string",
   "tags": { 
      "string" : "string" 
   },
   "zeroEtlAccess": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

availabilityZone

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

This operation requires that you specify a value for either availabilityZone or availabilityZoneId.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

availabilityZoneId

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

This operation requires that you specify a value for either availabilityZone or availabilityZoneId.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

backupSubnetCidr

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

Constraints:

  • Must not overlap with the CIDR range of the client subnet.

  • Must not overlap with the CIDR ranges of the VPCs that are connected to the ODB network.

  • Must not use the following CIDR ranges that are reserved by OCI:

    • 100.106.0.0/16 and 100.107.0.0/16

    • 169.254.0.0/16

    • 224.0.0.0 - 239.255.255.255

    • 240.0.0.0 - 255.255.255.255

Type: String

Length Constraints: Minimum length of 1. Maximum length of 43.

Required: No

clientSubnetCidr

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

Constraints:

  • Must not overlap with the CIDR range of the backup subnet.

  • Must not overlap with the CIDR ranges of the VPCs that are connected to the ODB network.

  • Must not use the following CIDR ranges that are reserved by OCI:

    • 100.106.0.0/16 and 100.107.0.0/16

    • 169.254.0.0/16

    • 224.0.0.0 - 239.255.255.255

    • 240.0.0.0 - 255.255.255.255

Type: String

Length Constraints: Minimum length of 1. Maximum length of 43.

Required: Yes

clientToken

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.

Type: String

Length Constraints: Minimum length of 8. Maximum length of 64.

Pattern: [a-zA-Z0-9_\/.=-]+

Required: No

customDomainName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

defaultDnsPrefix

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 15.

Pattern: [a-zA-Z][a-zA-Z0-9]*

Required: No

displayName

A user-friendly name for the ODB network.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

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

Required: Yes

s3Access

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

Type: String

Valid Values: ENABLED | DISABLED

Required: No

s3PolicyDocument

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

Type: String

Length Constraints: Minimum length of 3. Maximum length of 20480.

Required: No

tags

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

Type: String to string map

Map Entries: Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

zeroEtlAccess

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

Type: String

Valid Values: ENABLED | DISABLED

Required: No

Response Syntax

{
   "displayName": "string",
   "odbNetworkId": "string",
   "status": "string",
   "statusReason": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

displayName

The user-friendly name of the ODB network.

Type: String

odbNetworkId

The unique identifier of the ODB network.

Type: String

status

The current status of the ODB network.

Type: String

Valid Values: AVAILABLE | FAILED | PROVISIONING | TERMINATED | TERMINATING | UPDATING | MAINTENANCE_IN_PROGRESS

statusReason

Additional information about the status of the ODB network.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

HTTP Status Code: 400

ConflictException

Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

HTTP Status Code: 400

InternalServerException

Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.

HTTP Status Code: 500

ServiceQuotaExceededException

You have exceeded the service quota.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The request has failed validation because it is missing required fields or has invalid inputs.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: