@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
179 lines (178 loc) • 5.35 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Use this data source to get information about an EC2 Dedicated Host.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const testDedicatedHost = new aws.ec2.DedicatedHost("test", {
* instanceType: "c5.18xlarge",
* availabilityZone: "us-west-2a",
* });
* const test = aws.ec2.getDedicatedHostOutput({
* hostId: testDedicatedHost.id,
* });
* ```
*
* ### Filter Example
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const test = aws.ec2.getDedicatedHost({
* filters: [{
* name: "instance-type",
* values: ["c5.18xlarge"],
* }],
* });
* ```
*/
export declare function getDedicatedHost(args?: GetDedicatedHostArgs, opts?: pulumi.InvokeOptions): Promise<GetDedicatedHostResult>;
/**
* A collection of arguments for invoking getDedicatedHost.
*/
export interface GetDedicatedHostArgs {
/**
* Configuration block. Detailed below.
*/
filters?: inputs.ec2.GetDedicatedHostFilter[];
/**
* ID of the Dedicated Host.
*
* The arguments of this data source act as filters for querying the available EC2 Hosts in the current region.
* The given filters must match exactly one host whose data will be exported as attributes.
*/
hostId?: 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;
tags?: {
[key: string]: string;
};
}
/**
* A collection of values returned by getDedicatedHost.
*/
export interface GetDedicatedHostResult {
/**
* ARN of the Dedicated Host.
*/
readonly arn: string;
/**
* The ID of the Outpost hardware asset on which the Dedicated Host is allocated.
*/
readonly assetId: string;
/**
* Whether auto-placement is on or off.
*/
readonly autoPlacement: string;
/**
* Availability Zone of the Dedicated Host.
*/
readonly availabilityZone: string;
/**
* Number of cores on the Dedicated Host.
*/
readonly cores: number;
readonly filters?: outputs.ec2.GetDedicatedHostFilter[];
readonly hostId: string;
/**
* Whether host recovery is enabled or disabled for the Dedicated Host.
*/
readonly hostRecovery: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* Instance family supported by the Dedicated Host. For example, "m5".
*/
readonly instanceFamily: string;
/**
* Instance type supported by the Dedicated Host. For example, "m5.large". If the host supports multiple instance types, no instanceType is returned.
*/
readonly instanceType: string;
/**
* ARN of the AWS Outpost on which the Dedicated Host is allocated.
*/
readonly outpostArn: string;
/**
* ID of the AWS account that owns the Dedicated Host.
*/
readonly ownerId: string;
readonly region: string;
/**
* Number of sockets on the Dedicated Host.
*/
readonly sockets: number;
readonly tags: {
[key: string]: string;
};
/**
* Total number of vCPUs on the Dedicated Host.
*/
readonly totalVcpus: number;
}
/**
* Use this data source to get information about an EC2 Dedicated Host.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const testDedicatedHost = new aws.ec2.DedicatedHost("test", {
* instanceType: "c5.18xlarge",
* availabilityZone: "us-west-2a",
* });
* const test = aws.ec2.getDedicatedHostOutput({
* hostId: testDedicatedHost.id,
* });
* ```
*
* ### Filter Example
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const test = aws.ec2.getDedicatedHost({
* filters: [{
* name: "instance-type",
* values: ["c5.18xlarge"],
* }],
* });
* ```
*/
export declare function getDedicatedHostOutput(args?: GetDedicatedHostOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDedicatedHostResult>;
/**
* A collection of arguments for invoking getDedicatedHost.
*/
export interface GetDedicatedHostOutputArgs {
/**
* Configuration block. Detailed below.
*/
filters?: pulumi.Input<pulumi.Input<inputs.ec2.GetDedicatedHostFilterArgs>[]>;
/**
* ID of the Dedicated Host.
*
* The arguments of this data source act as filters for querying the available EC2 Hosts in the current region.
* The given filters must match exactly one host whose data will be exported as attributes.
*/
hostId?: 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>;
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}