1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. odb
  5. getOdbNetwork

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.36.0 published on Friday, Oct 3, 2025 by Pulumi

aws-native.odb.getOdbNetwork

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.36.0 published on Friday, Oct 3, 2025 by Pulumi

    The AWS::ODB::OdbNetwork resource creates an ODB Network

    Using getOdbNetwork

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getOdbNetwork(args: GetOdbNetworkArgs, opts?: InvokeOptions): Promise<GetOdbNetworkResult>
    function getOdbNetworkOutput(args: GetOdbNetworkOutputArgs, opts?: InvokeOptions): Output<GetOdbNetworkResult>
    def get_odb_network(odb_network_arn: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetOdbNetworkResult
    def get_odb_network_output(odb_network_arn: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetOdbNetworkResult]
    func LookupOdbNetwork(ctx *Context, args *LookupOdbNetworkArgs, opts ...InvokeOption) (*LookupOdbNetworkResult, error)
    func LookupOdbNetworkOutput(ctx *Context, args *LookupOdbNetworkOutputArgs, opts ...InvokeOption) LookupOdbNetworkResultOutput

    > Note: This function is named LookupOdbNetwork in the Go SDK.

    public static class GetOdbNetwork 
    {
        public static Task<GetOdbNetworkResult> InvokeAsync(GetOdbNetworkArgs args, InvokeOptions? opts = null)
        public static Output<GetOdbNetworkResult> Invoke(GetOdbNetworkInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetOdbNetworkResult> getOdbNetwork(GetOdbNetworkArgs args, InvokeOptions options)
    public static Output<GetOdbNetworkResult> getOdbNetwork(GetOdbNetworkArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aws-native:odb:getOdbNetwork
      arguments:
        # arguments dictionary

    The following arguments are supported:

    OdbNetworkArn string
    The Amazon Resource Name (ARN) of the ODB network.
    OdbNetworkArn string
    The Amazon Resource Name (ARN) of the ODB network.
    odbNetworkArn String
    The Amazon Resource Name (ARN) of the ODB network.
    odbNetworkArn string
    The Amazon Resource Name (ARN) of the ODB network.
    odb_network_arn str
    The Amazon Resource Name (ARN) of the ODB network.
    odbNetworkArn String
    The Amazon Resource Name (ARN) of the ODB network.

    getOdbNetwork Result

    The following output properties are available:

    DisplayName string
    The user-friendly name of the ODB network.
    ManagedServices Pulumi.AwsNative.Odb.Outputs.OdbNetworkManagedServices
    OciNetworkAnchorId string
    The unique identifier of the OCI network anchor for the ODB network.
    OciResourceAnchorName string
    The name of the OCI resource anchor that's associated with the ODB network.
    OciVcnUrl string
    The URL for the VCN that's associated with the ODB network.
    OdbNetworkArn string
    The Amazon Resource Name (ARN) of the ODB network.
    OdbNetworkId string
    The unique identifier of the ODB network.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    Tags to assign to the Odb Network.
    DisplayName string
    The user-friendly name of the ODB network.
    ManagedServices OdbNetworkManagedServices
    OciNetworkAnchorId string
    The unique identifier of the OCI network anchor for the ODB network.
    OciResourceAnchorName string
    The name of the OCI resource anchor that's associated with the ODB network.
    OciVcnUrl string
    The URL for the VCN that's associated with the ODB network.
    OdbNetworkArn string
    The Amazon Resource Name (ARN) of the ODB network.
    OdbNetworkId string
    The unique identifier of the ODB network.
    Tags Tag
    Tags to assign to the Odb Network.
    displayName String
    The user-friendly name of the ODB network.
    managedServices OdbNetworkManagedServices
    ociNetworkAnchorId String
    The unique identifier of the OCI network anchor for the ODB network.
    ociResourceAnchorName String
    The name of the OCI resource anchor that's associated with the ODB network.
    ociVcnUrl String
    The URL for the VCN that's associated with the ODB network.
    odbNetworkArn String
    The Amazon Resource Name (ARN) of the ODB network.
    odbNetworkId String
    The unique identifier of the ODB network.
    tags List<Tag>
    Tags to assign to the Odb Network.
    displayName string
    The user-friendly name of the ODB network.
    managedServices OdbNetworkManagedServices
    ociNetworkAnchorId string
    The unique identifier of the OCI network anchor for the ODB network.
    ociResourceAnchorName string
    The name of the OCI resource anchor that's associated with the ODB network.
    ociVcnUrl string
    The URL for the VCN that's associated with the ODB network.
    odbNetworkArn string
    The Amazon Resource Name (ARN) of the ODB network.
    odbNetworkId string
    The unique identifier of the ODB network.
    tags Tag[]
    Tags to assign to the Odb Network.
    display_name str
    The user-friendly name of the ODB network.
    managed_services OdbNetworkManagedServices
    oci_network_anchor_id str
    The unique identifier of the OCI network anchor for the ODB network.
    oci_resource_anchor_name str
    The name of the OCI resource anchor that's associated with the ODB network.
    oci_vcn_url str
    The URL for the VCN that's associated with the ODB network.
    odb_network_arn str
    The Amazon Resource Name (ARN) of the ODB network.
    odb_network_id str
    The unique identifier of the ODB network.
    tags Sequence[root_Tag]
    Tags to assign to the Odb Network.
    displayName String
    The user-friendly name of the ODB network.
    managedServices Property Map
    ociNetworkAnchorId String
    The unique identifier of the OCI network anchor for the ODB network.
    ociResourceAnchorName String
    The name of the OCI resource anchor that's associated with the ODB network.
    ociVcnUrl String
    The URL for the VCN that's associated with the ODB network.
    odbNetworkArn String
    The Amazon Resource Name (ARN) of the ODB network.
    odbNetworkId String
    The unique identifier of the ODB network.
    tags List<Property Map>
    Tags to assign to the Odb Network.

    Supporting Types

    OdbNetworkManagedResourceStatus

    OdbNetworkManagedServices

    ManagedS3BackupAccess Pulumi.AwsNative.Odb.Inputs.OdbNetworkManagedServicesManagedS3BackupAccessProperties
    The managed Amazon S3 backup access configuration.
    ManagedServicesIpv4Cidrs List<string>
    The IPv4 CIDR blocks for the managed services.
    ResourceGatewayArn string
    The Amazon Resource Name (ARN) of the resource gateway.
    S3Access Pulumi.AwsNative.Odb.Inputs.OdbNetworkManagedServicesS3AccessProperties
    The Amazon S3 access configuration.
    ServiceNetworkArn string
    The Amazon Resource Name (ARN) of the service network.
    ServiceNetworkEndpoint Pulumi.AwsNative.Odb.Inputs.OdbNetworkManagedServicesServiceNetworkEndpointProperties
    The service network endpoint configuration.
    ZeroEtlAccess Pulumi.AwsNative.Odb.Inputs.OdbNetworkManagedServicesZeroEtlAccessProperties
    The Zero-ETL access configuration.
    ManagedS3BackupAccess OdbNetworkManagedServicesManagedS3BackupAccessProperties
    The managed Amazon S3 backup access configuration.
    ManagedServicesIpv4Cidrs []string
    The IPv4 CIDR blocks for the managed services.
    ResourceGatewayArn string
    The Amazon Resource Name (ARN) of the resource gateway.
    S3Access OdbNetworkManagedServicesS3AccessProperties
    The Amazon S3 access configuration.
    ServiceNetworkArn string
    The Amazon Resource Name (ARN) of the service network.
    ServiceNetworkEndpoint OdbNetworkManagedServicesServiceNetworkEndpointProperties
    The service network endpoint configuration.
    ZeroEtlAccess OdbNetworkManagedServicesZeroEtlAccessProperties
    The Zero-ETL access configuration.
    managedS3BackupAccess OdbNetworkManagedServicesManagedS3BackupAccessProperties
    The managed Amazon S3 backup access configuration.
    managedServicesIpv4Cidrs List<String>
    The IPv4 CIDR blocks for the managed services.
    resourceGatewayArn String
    The Amazon Resource Name (ARN) of the resource gateway.
    s3Access OdbNetworkManagedServicesS3AccessProperties
    The Amazon S3 access configuration.
    serviceNetworkArn String
    The Amazon Resource Name (ARN) of the service network.
    serviceNetworkEndpoint OdbNetworkManagedServicesServiceNetworkEndpointProperties
    The service network endpoint configuration.
    zeroEtlAccess OdbNetworkManagedServicesZeroEtlAccessProperties
    The Zero-ETL access configuration.
    managedS3BackupAccess OdbNetworkManagedServicesManagedS3BackupAccessProperties
    The managed Amazon S3 backup access configuration.
    managedServicesIpv4Cidrs string[]
    The IPv4 CIDR blocks for the managed services.
    resourceGatewayArn string
    The Amazon Resource Name (ARN) of the resource gateway.
    s3Access OdbNetworkManagedServicesS3AccessProperties
    The Amazon S3 access configuration.
    serviceNetworkArn string
    The Amazon Resource Name (ARN) of the service network.
    serviceNetworkEndpoint OdbNetworkManagedServicesServiceNetworkEndpointProperties
    The service network endpoint configuration.
    zeroEtlAccess OdbNetworkManagedServicesZeroEtlAccessProperties
    The Zero-ETL access configuration.
    managed_s3_backup_access OdbNetworkManagedServicesManagedS3BackupAccessProperties
    The managed Amazon S3 backup access configuration.
    managed_services_ipv4_cidrs Sequence[str]
    The IPv4 CIDR blocks for the managed services.
    resource_gateway_arn str
    The Amazon Resource Name (ARN) of the resource gateway.
    s3_access OdbNetworkManagedServicesS3AccessProperties
    The Amazon S3 access configuration.
    service_network_arn str
    The Amazon Resource Name (ARN) of the service network.
    service_network_endpoint OdbNetworkManagedServicesServiceNetworkEndpointProperties
    The service network endpoint configuration.
    zero_etl_access OdbNetworkManagedServicesZeroEtlAccessProperties
    The Zero-ETL access configuration.
    managedS3BackupAccess Property Map
    The managed Amazon S3 backup access configuration.
    managedServicesIpv4Cidrs List<String>
    The IPv4 CIDR blocks for the managed services.
    resourceGatewayArn String
    The Amazon Resource Name (ARN) of the resource gateway.
    s3Access Property Map
    The Amazon S3 access configuration.
    serviceNetworkArn String
    The Amazon Resource Name (ARN) of the service network.
    serviceNetworkEndpoint Property Map
    The service network endpoint configuration.
    zeroEtlAccess Property Map
    The Zero-ETL access configuration.

    OdbNetworkManagedServicesManagedS3BackupAccessProperties

    Ipv4Addresses List<string>
    The IPv4 addresses for the managed Amazon S3 backup access.
    Status Pulumi.AwsNative.Odb.OdbNetworkManagedResourceStatus
    The status of the managed Amazon S3 backup access.
    Ipv4Addresses []string
    The IPv4 addresses for the managed Amazon S3 backup access.
    Status OdbNetworkManagedResourceStatus
    The status of the managed Amazon S3 backup access.
    ipv4Addresses List<String>
    The IPv4 addresses for the managed Amazon S3 backup access.
    status OdbNetworkManagedResourceStatus
    The status of the managed Amazon S3 backup access.
    ipv4Addresses string[]
    The IPv4 addresses for the managed Amazon S3 backup access.
    status OdbNetworkManagedResourceStatus
    The status of the managed Amazon S3 backup access.
    ipv4_addresses Sequence[str]
    The IPv4 addresses for the managed Amazon S3 backup access.
    status OdbNetworkManagedResourceStatus
    The status of the managed Amazon S3 backup access.
    ipv4Addresses List<String>
    The IPv4 addresses for the managed Amazon S3 backup access.
    status "ENABLED" | "ENABLING" | "DISABLED" | "DISABLING"
    The status of the managed Amazon S3 backup access.

    OdbNetworkManagedServicesS3AccessProperties

    DomainName string
    The domain name for the Amazon S3 access.
    Ipv4Addresses List<string>
    The IPv4 addresses for the Amazon S3 access.
    S3PolicyDocument string
    The endpoint policy for the Amazon S3 access.
    Status Pulumi.AwsNative.Odb.OdbNetworkManagedResourceStatus
    The status of the Amazon S3 access.
    DomainName string
    The domain name for the Amazon S3 access.
    Ipv4Addresses []string
    The IPv4 addresses for the Amazon S3 access.
    S3PolicyDocument string
    The endpoint policy for the Amazon S3 access.
    Status OdbNetworkManagedResourceStatus
    The status of the Amazon S3 access.
    domainName String
    The domain name for the Amazon S3 access.
    ipv4Addresses List<String>
    The IPv4 addresses for the Amazon S3 access.
    s3PolicyDocument String
    The endpoint policy for the Amazon S3 access.
    status OdbNetworkManagedResourceStatus
    The status of the Amazon S3 access.
    domainName string
    The domain name for the Amazon S3 access.
    ipv4Addresses string[]
    The IPv4 addresses for the Amazon S3 access.
    s3PolicyDocument string
    The endpoint policy for the Amazon S3 access.
    status OdbNetworkManagedResourceStatus
    The status of the Amazon S3 access.
    domain_name str
    The domain name for the Amazon S3 access.
    ipv4_addresses Sequence[str]
    The IPv4 addresses for the Amazon S3 access.
    s3_policy_document str
    The endpoint policy for the Amazon S3 access.
    status OdbNetworkManagedResourceStatus
    The status of the Amazon S3 access.
    domainName String
    The domain name for the Amazon S3 access.
    ipv4Addresses List<String>
    The IPv4 addresses for the Amazon S3 access.
    s3PolicyDocument String
    The endpoint policy for the Amazon S3 access.
    status "ENABLED" | "ENABLING" | "DISABLED" | "DISABLING"
    The status of the Amazon S3 access.

    OdbNetworkManagedServicesServiceNetworkEndpointProperties

    VpcEndpointId string
    The identifier of the VPC endpoint.
    VpcEndpointType OdbNetworkManagedServicesServiceNetworkEndpointPropertiesVpcEndpointType
    The type of the VPC endpoint.
    vpcEndpointId String
    The identifier of the VPC endpoint.
    vpcEndpointType OdbNetworkManagedServicesServiceNetworkEndpointPropertiesVpcEndpointType
    The type of the VPC endpoint.
    vpcEndpointId string
    The identifier of the VPC endpoint.
    vpcEndpointType OdbNetworkManagedServicesServiceNetworkEndpointPropertiesVpcEndpointType
    The type of the VPC endpoint.
    vpcEndpointId String
    The identifier of the VPC endpoint.
    vpcEndpointType "SERVICENETWORK"
    The type of the VPC endpoint.

    OdbNetworkManagedServicesServiceNetworkEndpointPropertiesVpcEndpointType

    OdbNetworkManagedServicesZeroEtlAccessProperties

    Cidr string
    The CIDR block for the Zero-ETL access.
    Status Pulumi.AwsNative.Odb.OdbNetworkManagedResourceStatus
    The status of the Zero-ETL access.
    Cidr string
    The CIDR block for the Zero-ETL access.
    Status OdbNetworkManagedResourceStatus
    The status of the Zero-ETL access.
    cidr String
    The CIDR block for the Zero-ETL access.
    status OdbNetworkManagedResourceStatus
    The status of the Zero-ETL access.
    cidr string
    The CIDR block for the Zero-ETL access.
    status OdbNetworkManagedResourceStatus
    The status of the Zero-ETL access.
    cidr str
    The CIDR block for the Zero-ETL access.
    status OdbNetworkManagedResourceStatus
    The status of the Zero-ETL access.
    cidr String
    The CIDR block for the Zero-ETL access.
    status "ENABLED" | "ENABLING" | "DISABLED" | "DISABLING"
    The status of the Zero-ETL access.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.36.0 published on Friday, Oct 3, 2025 by Pulumi
      AI Agentic Workflows: Register now