UNPKG

@pulumi/aws

Version:

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

157 lines (156 loc) 4.62 kB
import * as pulumi from "@pulumi/pulumi"; import * as outputs from "../types/output"; /** * Data source for to retrieve network resource in AWS for Oracle Database@AWS. * * ## Example Usage * * ### Basic Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = aws.odb.getNetwork({ * id: "example", * }); * ``` */ export declare function getNetwork(args: GetNetworkArgs, opts?: pulumi.InvokeOptions): Promise<GetNetworkResult>; /** * A collection of arguments for invoking getNetwork. */ export interface GetNetworkArgs { /** * Unique identifier of the odb network resource. * * The following arguments are optional: */ id: string; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: string; } /** * A collection of values returned by getNetwork. */ export interface GetNetworkResult { /** * Amazon Resource Name (ARN) of the odb network resource. */ readonly arn: string; /** * The availability zone where the ODB network is located. */ readonly availabilityZone: string; /** * The AZ ID of the AZ where the ODB network is located. */ readonly availabilityZoneId: string; /** * The CIDR range of the backup subnet for the ODB network. */ readonly backupSubnetCidr: string; /** * The CIDR notation for the network resource. */ readonly clientSubnetCidr: string; /** * The date and time when the ODB network was created. */ readonly createdAt: string; /** * The name of the custom domain that the network is located. */ readonly customDomainName: string; /** * The default DNS prefix for the network resource. */ readonly defaultDnsPrefix: string; /** * Display name for the network resource. */ readonly displayName: string; /** * Unique identifier of the odb network resource. */ readonly id: string; /** * The managed services configuration for the ODB network. */ readonly managedServices: outputs.odb.GetNetworkManagedService[]; readonly ociDnsForwardingConfigs: outputs.odb.GetNetworkOciDnsForwardingConfig[]; /** * The unique identifier of the OCI network anchor for the ODB network. */ readonly ociNetworkAnchorId: string; /** * The URL of the OCI network anchor for the ODB network. */ readonly ociNetworkAnchorUrl: string; /** * The name of the OCI resource anchor for the ODB network. */ readonly ociResourceAnchorName: string; /** * The unique identifier Oracle Cloud ID (OCID) of the OCI VCN for the ODB network. */ readonly ociVcnId: string; /** * The URL of the OCI VCN for the ODB network. */ readonly ociVcnUrl: string; /** * The list of CIDR ranges from the peered VPC that are allowed access to the ODB network. Please refer odb network peering documentation. */ readonly peeredCidrs: string[]; /** * The amount of progress made on the current operation on the ODB network, expressed as a percentage. */ readonly percentProgress: number; readonly region: string; /** * The status of the network resource. */ readonly status: string; /** * Additional information about the current status of the ODB network. */ readonly statusReason: string; readonly tags: { [key: string]: string; }; } /** * Data source for to retrieve network resource in AWS for Oracle Database@AWS. * * ## Example Usage * * ### Basic Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = aws.odb.getNetwork({ * id: "example", * }); * ``` */ export declare function getNetworkOutput(args: GetNetworkOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetNetworkResult>; /** * A collection of arguments for invoking getNetwork. */ export interface GetNetworkOutputArgs { /** * Unique identifier of the odb network resource. * * The following arguments are optional: */ id: pulumi.Input<string>; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: pulumi.Input<string>; }