Skip to content

OdbNetwork

Source code in docs_src/capo_odb/types/odb_network.py
class OdbNetwork(TypedDict, closed=True):
    odb_network_id: "capo_odb.types.resource_id_or_arn.ResourceIdOrArn"
    """<p>The unique identifier of the ODB network.</p>"""
    display_name: NotRequired["str"]
    """<p>The user-friendly name of the ODB network.</p>"""
    status: NotRequired["capo_odb.types.resource_status.ResourceStatus"]
    """<p>The current status of the ODB network.</p>"""
    status_reason: NotRequired["str"]
    """<p>Additional information about the current status of the ODB network.</p>"""
    odb_network_arn: NotRequired["str"]
    """<p>The Amazon Resource Name (ARN) of the ODB network.</p>"""
    availability_zone: NotRequired["str"]
    """<p>The Amazon Web Services Availability Zone (AZ) where the ODB network is located.</p>"""
    availability_zone_id: NotRequired["str"]
    """<p>The AZ ID of the AZ where the ODB network is located.</p>"""
    client_subnet_cidr: NotRequired["str"]
    """<p>The CIDR range of the client subnet in the ODB network.</p>"""
    backup_subnet_cidr: NotRequired["str"]
    """<p>The CIDR range of the backup subnet in the ODB network.</p>"""
    custom_domain_name: NotRequired["str"]
    """<p>The domain name 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>"""
    peered_cidrs: NotRequired["capo_odb.types.string_list.StringList"]
    """<p>The list of CIDR ranges from the peered VPC that are allowed access to the ODB network.</p>"""
    oci_network_anchor_id: NotRequired["str"]
    """<p>The unique identifier of the OCI network anchor for the ODB network.</p>"""
    oci_network_anchor_url: NotRequired["str"]
    """<p>The URL of the OCI network anchor for the ODB network.</p>"""
    oci_resource_anchor_name: NotRequired["str"]
    """<p>The name of the OCI resource anchor that's associated with the ODB network.</p>"""
    oci_vcn_id: NotRequired["str"]
    """<p>The Oracle Cloud ID (OCID) for the Virtual Cloud Network (VCN) that's associated with the ODB network.</p>"""
    oci_vcn_url: NotRequired["str"]
    """<p>The URL for the VCN that's associated with the ODB network.</p>"""
    oci_dns_forwarding_configs: NotRequired[
        "capo_odb.types.oci_dns_forwarding_config_list.OciDnsForwardingConfigList"
    ]
    """<p>The DNS resolver endpoint in OCI for forwarding DNS queries for the ociPrivateZone domain.</p>"""
    created_at: NotRequired["datetime.datetime"]
    """<p>The date and time when the ODB network was created.</p>"""
    percent_progress: NotRequired["float"]
    """<p>The amount of progress made on the current operation on the ODB network, expressed as a percentage.</p>"""
    managed_services: NotRequired["capo_odb.types.managed_services.ManagedServices"]
    """<p>The managed services configuration for the ODB network.</p>"""
    ec2_placement_group_ids: NotRequired[
        "capo_odb.types.resource_id_list.ResourceIdList"
    ]
    """<p>The list of EC2 Placement Group IDs associated with your ODB network.</p>"""

availability_zone instance-attribute

availability_zone: NotRequired[str]

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

availability_zone_id instance-attribute

availability_zone_id: NotRequired[str]

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

backup_subnet_cidr instance-attribute

backup_subnet_cidr: NotRequired[str]

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

client_subnet_cidr instance-attribute

client_subnet_cidr: NotRequired[str]

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

created_at instance-attribute

created_at: NotRequired[datetime]

The date and time when the ODB network was created.

custom_domain_name instance-attribute

custom_domain_name: NotRequired[str]

The domain name 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: NotRequired[str]

The user-friendly name of the ODB network.

ec2_placement_group_ids instance-attribute

ec2_placement_group_ids: NotRequired[ResourceIdList]

The list of EC2 Placement Group IDs associated with your ODB network.

managed_services instance-attribute

managed_services: NotRequired[ManagedServices]

The managed services configuration for the ODB network.

oci_dns_forwarding_configs instance-attribute

oci_dns_forwarding_configs: NotRequired[OciDnsForwardingConfigList]

The DNS resolver endpoint in OCI for forwarding DNS queries for the ociPrivateZone domain.

oci_network_anchor_id instance-attribute

oci_network_anchor_id: NotRequired[str]

The unique identifier of the OCI network anchor for the ODB network.

oci_network_anchor_url instance-attribute

oci_network_anchor_url: NotRequired[str]

The URL of the OCI network anchor for the ODB network.

oci_resource_anchor_name instance-attribute

oci_resource_anchor_name: NotRequired[str]

The name of the OCI resource anchor that's associated with the ODB network.

oci_vcn_id instance-attribute

oci_vcn_id: NotRequired[str]

The Oracle Cloud ID (OCID) for the Virtual Cloud Network (VCN) that's associated with the ODB network.

oci_vcn_url instance-attribute

oci_vcn_url: NotRequired[str]

The URL for the VCN that's associated with the ODB network.

odb_network_arn instance-attribute

odb_network_arn: NotRequired[str]

The Amazon Resource Name (ARN) of the ODB network.

odb_network_id instance-attribute

odb_network_id: ResourceIdOrArn

The unique identifier of the ODB network.

peered_cidrs instance-attribute

peered_cidrs: NotRequired[StringList]

The list of CIDR ranges from the peered VPC that are allowed access to the ODB network.

percent_progress instance-attribute

percent_progress: NotRequired[float]

The amount of progress made on the current operation on the ODB network, expressed as a percentage.

status instance-attribute

status: NotRequired[ResourceStatus]

The current status of the ODB network.

status_reason instance-attribute

status_reason: NotRequired[str]

Additional information about the current status of the ODB network.