Skip to content

CreateOdbNetworkInput

Source code in docs_src/capo_odb/types/create_odb_network_input.py
class CreateOdbNetworkInput(TypedDict, closed=True):
    display_name: "capo_odb.types.resource_display_name.ResourceDisplayName"
    """<p>A user-friendly name for the ODB network.</p>"""
    availability_zone: NotRequired["str"]
    """<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>"""
    availability_zone_id: NotRequired["str"]
    """<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>"""
    client_subnet_cidr: "str"
    """<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>"""
    backup_subnet_cidr: NotRequired["str"]
    """<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>"""
    custom_domain_name: NotRequired["str"]
    """<p>The domain name to use for the resources in the ODB network.</p>"""
    default_dns_prefix: NotRequired["str"]
    """<p>The DNS prefix to the default DNS domain name. The default DNS domain name is oraclevcn.com.</p>"""
    client_token: NotRequired["capo_odb.types.general_input_string.GeneralInputString"]
    """<p>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.</p>"""
    s3_access: NotRequired["capo_odb.types.access.Access"]
    """<p>Specifies the configuration for Amazon S3 access from the ODB network.</p>"""
    zero_etl_access: NotRequired["capo_odb.types.access.Access"]
    """<p>Specifies the configuration for Zero-ETL access from the ODB network.</p>"""
    sts_access: NotRequired["capo_odb.types.access.Access"]
    """<p>The Amazon Web Services Security Token Service (STS) access configuration for the ODB network.</p>"""
    kms_access: NotRequired["capo_odb.types.access.Access"]
    """<p>The Amazon Web Services Key Management Service (KMS) access configuration for the ODB network.</p>"""
    s3_policy_document: NotRequired["capo_odb.types.policy_document.PolicyDocument"]
    """<p>Specifies the endpoint policy for Amazon S3 access from the ODB network.</p>"""
    sts_policy_document: NotRequired["capo_odb.types.policy_document.PolicyDocument"]
    """<p>The Amazon Web Services Security Token Service (STS) policy document that defines permissions for token service usage within the ODB network.</p>"""
    kms_policy_document: NotRequired["capo_odb.types.policy_document.PolicyDocument"]
    """<p>The Amazon Web Services Key Management Service (KMS) policy document that defines permissions for key usage within the ODB network.</p>"""
    cross_region_s3_restore_sources_to_enable: NotRequired[
        "capo_odb.types.string_list.StringList"
    ]
    """<p>The cross-Region Amazon S3 restore sources to enable for the ODB network.</p>"""
    tags: NotRequired["capo_odb.types.request_tag_map.RequestTagMap"]
    """<p>The list of resource tags to apply to the ODB network.</p>"""

availability_zone instance-attribute

availability_zone: NotRequired[str]

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.

availability_zone_id instance-attribute

availability_zone_id: NotRequired[str]

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.

backup_subnet_cidr instance-attribute

backup_subnet_cidr: NotRequired[str]

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

client_subnet_cidr instance-attribute

client_subnet_cidr: str

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

client_token instance-attribute

client_token: NotRequired[GeneralInputString]

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.

cross_region_s3_restore_sources_to_enable instance-attribute

cross_region_s3_restore_sources_to_enable: NotRequired[StringList]

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

custom_domain_name instance-attribute

custom_domain_name: NotRequired[str]

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

default_dns_prefix instance-attribute

default_dns_prefix: NotRequired[str]

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

display_name instance-attribute

display_name: ResourceDisplayName

A user-friendly name for the ODB network.

kms_access instance-attribute

kms_access: NotRequired[Access]

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

kms_policy_document instance-attribute

kms_policy_document: NotRequired[PolicyDocument]

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

s3_access instance-attribute

s3_access: NotRequired[Access]

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

s3_policy_document instance-attribute

s3_policy_document: NotRequired[PolicyDocument]

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

sts_access instance-attribute

sts_access: NotRequired[Access]

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

sts_policy_document instance-attribute

sts_policy_document: NotRequired[PolicyDocument]

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

tags instance-attribute

tags: NotRequired[RequestTagMap]

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

zero_etl_access instance-attribute

zero_etl_access: NotRequired[Access]

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