@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
206 lines (205 loc) • 9.98 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides an EC2 Host resource. This allows Dedicated Hosts to be allocated, modified, and released.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* // Create a new host with instance type of c5.18xlarge with Auto Placement
* // and Host Recovery enabled.
* const test = new aws.ec2.DedicatedHost("test", {
* instanceType: "c5.18xlarge",
* availabilityZone: "us-west-2a",
* hostRecovery: "on",
* autoPlacement: "on",
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import hosts using the host `id`. For example:
*
* ```sh
* $ pulumi import aws:ec2/dedicatedHost:DedicatedHost example h-0385a99d0e4b20cbb
* ```
*/
export declare class DedicatedHost extends pulumi.CustomResource {
/**
* Get an existing DedicatedHost resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DedicatedHostState, opts?: pulumi.CustomResourceOptions): DedicatedHost;
/**
* Returns true if the given object is an instance of DedicatedHost. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is DedicatedHost;
/**
* The ARN of the Dedicated Host.
*/
readonly arn: pulumi.Output<string>;
/**
* The ID of the Outpost hardware asset on which to allocate the Dedicated Hosts. This parameter is supported only if you specify OutpostArn. If you are allocating the Dedicated Hosts in a Region, omit this parameter.
*/
readonly assetId: pulumi.Output<string>;
/**
* Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. Valid values: `on`, `off`. Default: `on`.
*/
readonly autoPlacement: pulumi.Output<string | undefined>;
/**
* The Availability Zone in which to allocate the Dedicated Host.
*/
readonly availabilityZone: pulumi.Output<string>;
/**
* Indicates whether to enable or disable host recovery for the Dedicated Host. Valid values: `on`, `off`. Default: `off`.
*/
readonly hostRecovery: pulumi.Output<string | undefined>;
/**
* Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family. Exactly one of `instanceFamily` or `instanceType` must be specified.
*/
readonly instanceFamily: pulumi.Output<string | undefined>;
/**
* Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only. Exactly one of `instanceFamily` or `instanceType` must be specified.
*/
readonly instanceType: pulumi.Output<string | undefined>;
/**
* The Amazon Resource Name (ARN) of the AWS Outpost on which to allocate the Dedicated Host.
*/
readonly outpostArn: pulumi.Output<string | undefined>;
/**
* The ID of the AWS account that owns the Dedicated Host.
*/
readonly ownerId: pulumi.Output<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.
*/
readonly region: pulumi.Output<string>;
/**
* Map of tags to assign to this resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* Create a DedicatedHost resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: DedicatedHostArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DedicatedHost resources.
*/
export interface DedicatedHostState {
/**
* The ARN of the Dedicated Host.
*/
arn?: pulumi.Input<string>;
/**
* The ID of the Outpost hardware asset on which to allocate the Dedicated Hosts. This parameter is supported only if you specify OutpostArn. If you are allocating the Dedicated Hosts in a Region, omit this parameter.
*/
assetId?: pulumi.Input<string>;
/**
* Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. Valid values: `on`, `off`. Default: `on`.
*/
autoPlacement?: pulumi.Input<string>;
/**
* The Availability Zone in which to allocate the Dedicated Host.
*/
availabilityZone?: pulumi.Input<string>;
/**
* Indicates whether to enable or disable host recovery for the Dedicated Host. Valid values: `on`, `off`. Default: `off`.
*/
hostRecovery?: pulumi.Input<string>;
/**
* Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family. Exactly one of `instanceFamily` or `instanceType` must be specified.
*/
instanceFamily?: pulumi.Input<string>;
/**
* Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only. Exactly one of `instanceFamily` or `instanceType` must be specified.
*/
instanceType?: pulumi.Input<string>;
/**
* The Amazon Resource Name (ARN) of the AWS Outpost on which to allocate the Dedicated Host.
*/
outpostArn?: pulumi.Input<string>;
/**
* The ID of the AWS account that owns the Dedicated Host.
*/
ownerId?: 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>;
/**
* Map of tags to assign to this resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}
/**
* The set of arguments for constructing a DedicatedHost resource.
*/
export interface DedicatedHostArgs {
/**
* The ID of the Outpost hardware asset on which to allocate the Dedicated Hosts. This parameter is supported only if you specify OutpostArn. If you are allocating the Dedicated Hosts in a Region, omit this parameter.
*/
assetId?: pulumi.Input<string>;
/**
* Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. Valid values: `on`, `off`. Default: `on`.
*/
autoPlacement?: pulumi.Input<string>;
/**
* The Availability Zone in which to allocate the Dedicated Host.
*/
availabilityZone: pulumi.Input<string>;
/**
* Indicates whether to enable or disable host recovery for the Dedicated Host. Valid values: `on`, `off`. Default: `off`.
*/
hostRecovery?: pulumi.Input<string>;
/**
* Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family. Exactly one of `instanceFamily` or `instanceType` must be specified.
*/
instanceFamily?: pulumi.Input<string>;
/**
* Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only. Exactly one of `instanceFamily` or `instanceType` must be specified.
*/
instanceType?: pulumi.Input<string>;
/**
* The Amazon Resource Name (ARN) of the AWS Outpost on which to allocate the Dedicated Host.
*/
outpostArn?: 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>;
/**
* Map of tags to assign to this resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}