@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
196 lines (195 loc) • 5.65 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Data source for manging db nodes linked to cloud vm cluster of Oracle Database@AWS.
*
* You can find out more about Oracle Database@AWS from [User Guide](https://docs.aws.amazon.com/odb/latest/UserGuide/what-is-odb.html).
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.odb.getDbNode({
* cloudVmClusterId: "cloud_vm_cluster_id",
* id: "db_node_id",
* });
* ```
*/
export declare function getDbNode(args: GetDbNodeArgs, opts?: pulumi.InvokeOptions): Promise<GetDbNodeResult>;
/**
* A collection of arguments for invoking getDbNode.
*/
export interface GetDbNodeArgs {
/**
* The unique identifier of the cloud vm cluster.
*/
cloudVmClusterId: string;
/**
* The unique identifier of db node associated with vm cluster.
*
* 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 getDbNode.
*/
export interface GetDbNodeResult {
/**
* Additional information about the planned maintenance.
*/
readonly additionalDetails: string;
readonly arn: string;
/**
* The Oracle Cloud ID (OCID) of the backup IP address that's associated with the DB node.
*/
readonly backupIpId: string;
/**
* The OCID of the second backup VNIC.
*/
readonly backupVnic2Id: string;
/**
* The OCID of the backup VNIC.
*/
readonly backupVnicId: string;
/**
* The ID of the cloud VM cluster.
*/
readonly cloudVmClusterId: string;
/**
* The number of CPU cores enabled on the DB node.
*/
readonly cpuCoreCount: number;
/**
* The date and time when the DB node was created.
*/
readonly createdAt: string;
/**
* The unique identifier of the DB server that is associated with the DB node.
*/
readonly dbServerId: string;
/**
* The amount of local node storage, in gigabytes (GB), allocated on the DB node.
*/
readonly dbStorageSizeInGbs: number;
/**
* The OCID of the DB system.
*/
readonly dbSystemId: string;
/**
* The name of the fault domain the instance is contained in.
*/
readonly faultDomain: string;
/**
* The floating IP address assigned to the DB node.
*/
readonly floatingIpAddress: string;
/**
* The OCID of the host IP address that's associated with the DB node.
*/
readonly hostIpId: string;
/**
* The host name for the DB node.
*/
readonly hostname: string;
readonly id: string;
/**
* The type of database node maintenance. Either VMDB_REBOOT_MIGRATION or EXADBXS_REBOOT_MIGRATION.
*/
readonly maintenanceType: string;
/**
* The allocated memory in GBs on the DB node.
*/
readonly memorySizeInGbs: number;
/**
* The name of the OCI resource anchor for the DB node.
*/
readonly ociResourceAnchorName: string;
/**
* The OCID of the DB node.
*/
readonly ocid: string;
/**
* The private IP address assigned to the DB node.
*/
readonly privateIpAddress: string;
readonly region: string;
/**
* The size (in GB) of the block storage volume allocation for the DB system.
*/
readonly softwareStorageSizeInGbs: number;
/**
* The current status of the DB node.
*/
readonly status: string;
/**
* Additional information about the status of the DB node.
*/
readonly statusReason: string;
/**
* The end date and time of the maintenance window.
*/
readonly timeMaintenanceWindowEnd: string;
/**
* The start date and time of the maintenance window.
*/
readonly timeMaintenanceWindowStart: string;
/**
* The total number of CPU cores reserved on the DB node.
*/
readonly totalCpuCoreCount: number;
/**
* The OCID of the second VNIC.
*/
readonly vnic2Id: string;
/**
* The OCID of the VNIC.
*/
readonly vnicId: string;
}
/**
* Data source for manging db nodes linked to cloud vm cluster of Oracle Database@AWS.
*
* You can find out more about Oracle Database@AWS from [User Guide](https://docs.aws.amazon.com/odb/latest/UserGuide/what-is-odb.html).
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.odb.getDbNode({
* cloudVmClusterId: "cloud_vm_cluster_id",
* id: "db_node_id",
* });
* ```
*/
export declare function getDbNodeOutput(args: GetDbNodeOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDbNodeResult>;
/**
* A collection of arguments for invoking getDbNode.
*/
export interface GetDbNodeOutputArgs {
/**
* The unique identifier of the cloud vm cluster.
*/
cloudVmClusterId: pulumi.Input<string>;
/**
* The unique identifier of db node associated with vm cluster.
*
* 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>;
}