:doc:`odb <../../odb>` / Client / create_odb_network

******************
create_odb_network
******************



.. py:method:: odb.Client.create_odb_network(**kwargs)

  

  Creates an ODB network.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/odb-2024-08-20/CreateOdbNetwork>`_  


  **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',
        stsAccess='ENABLED'|'DISABLED',
        kmsAccess='ENABLED'|'DISABLED',
        s3PolicyDocument='string',
        stsPolicyDocument='string',
        kmsPolicyDocument='string',
        crossRegionS3RestoreSourcesToEnable=[
            'string',
        ],
        tags={
            'string': 'string'
        }
    )
    
  :type displayName: string
  :param displayName: **[REQUIRED]** 

    A user-friendly name for the ODB network.

    

  
  :type availabilityZone: string
  :param availabilityZone: 

    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``.

    

  
  :type availabilityZoneId: string
  :param 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 clientSubnetCidr: string
  :param clientSubnetCidr: **[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``
      

    
    

    

  
  :type backupSubnetCidr: string
  :param 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 customDomainName: string
  :param customDomainName: 

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

    

  
  :type defaultDnsPrefix: string
  :param defaultDnsPrefix: 

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

    

  
  :type clientToken: string
  :param 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.

    This field is autopopulated if not provided.

  
  :type s3Access: string
  :param s3Access: 

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

    

  
  :type zeroEtlAccess: string
  :param zeroEtlAccess: 

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

    

  
  :type stsAccess: string
  :param stsAccess: 

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

    

  
  :type kmsAccess: string
  :param kmsAccess: 

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

    

  
  :type s3PolicyDocument: string
  :param s3PolicyDocument: 

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

    

  
  :type stsPolicyDocument: string
  :param stsPolicyDocument: 

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

    

  
  :type kmsPolicyDocument: string
  :param kmsPolicyDocument: 

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

    

  
  :type crossRegionS3RestoreSourcesToEnable: list
  :param crossRegionS3RestoreSourcesToEnable: 

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

    

  
    - *(string) --* 

    

  :type tags: dict
  :param tags: 

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

    

  
    - *(string) --* 

    
      - *(string) --* 

      


  
  :rtype: 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**
  
  *   :py:class:`odb.Client.exceptions.ThrottlingException`

  
  *   :py:class:`odb.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`odb.Client.exceptions.ValidationException`

  
  *   :py:class:`odb.Client.exceptions.ConflictException`

  
  *   :py:class:`odb.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`odb.Client.exceptions.InternalServerException`

  