odb / Client / create_odb_network

create_odb_network

odb.Client.create_odb_network(**kwargs)

Creates an ODB network.

See also: AWS API Documentation

Request Syntax

response = client.create_odb_network(
    displayName='string',
    availabilityZone='string',
    availabilityZoneId='string',
    clientSubnetCidr='string',
    backupSubnetCidr='string',
    customDomainName='string',
    defaultDnsPrefix='string',
    clientToken='string',
    s3Access='ENABLED'|'DISABLED',
    zeroEtlAccess='ENABLED'|'DISABLED',
    s3PolicyDocument='string',
    tags={
        'string': 'string'
    }
)
Parameters:

  • displayName (string) –

    [REQUIRED]

    A user-friendly name for the ODB network.

  • availabilityZone (string) –

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

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

  • availabilityZoneId (string) –

    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.

  • clientSubnetCidr (string) –

    [REQUIRED]

    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

  • backupSubnetCidr (string) –

    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

  • customDomainName (string) – The domain name to use for the resources in the ODB network.

  • defaultDnsPrefix (string) – The DNS prefix to the default DNS domain name. The default DNS domain name is oraclevcn.com.

  • clientToken (string) –

    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.

    This field is autopopulated if not provided.

  • s3Access (string) – Specifies the configuration for Amazon S3 access from the ODB network.

  • zeroEtlAccess (string) – Specifies the configuration for Zero-ETL access from the ODB network.

  • s3PolicyDocument (string) – Specifies the endpoint policy for Amazon S3 access from the ODB network.

  • tags (dict) –

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

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'displayName': 'string',
    'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
    'statusReason': 'string',
    'odbNetworkId': 'string'
}

Response Structure

  • (dict) –

    • displayName (string) –

      The user-friendly name of the ODB network.

    • status (string) –

      The current status of the ODB network.

    • statusReason (string) –

      Additional information about the status of the ODB network.

    • odbNetworkId (string) –

      The unique identifier of the ODB network.

Exceptions