Resource Type definition for AWS::EC2::Host
Create Host Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
@overload
def Host(resource_name: str,
args: HostArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Host(resource_name: str,
opts: Optional[ResourceOptions] = None,
availability_zone: Optional[str] = None,
asset_id: Optional[str] = None,
auto_placement: Optional[HostAutoPlacement] = None,
host_maintenance: Optional[HostMaintenance] = None,
host_recovery: Optional[HostRecovery] = None,
instance_family: Optional[str] = None,
instance_type: Optional[str] = None,
outpost_arn: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
public Host(String name, HostArgs args)
public Host(String name, HostArgs args, CustomResourceOptions options)
type: aws-native:ec2:Host
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_ec2_host" "name" {
# resource properties
}
Parameters
- name
string
- The unique name of the resource.
- args
HostArgs
- The arguments to resource properties.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
str
- The unique name of the resource.
- args
HostArgs
- The arguments to resource properties.
- opts
ResourceOptions
- Bag of options to control resource's behavior.
- ctx
Context
- Context object for the current deployment.
- name
string
- The unique name of the resource.
- args
HostArgs
- The arguments to resource properties.
- opts
ResourceOption
- Bag of options to control resource's behavior.
- name
string
- The unique name of the resource.
- args
HostArgs
- The arguments to resource properties.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- name
String
- The unique name of the resource.
- args
HostArgs
- The arguments to resource properties.
- options
CustomResourceOptions
- Bag of options to control resource's behavior.
Host Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Host resource accepts the following input properties:
- AvailabilityZone
string
- The Availability Zone in which to allocate the Dedicated Host.
- AssetId
string
- The ID of the Outpost hardware asset.
- AutoPlacement
Pulumi.AwsNative.Ec2.HostAutoPlacement
- 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.
- HostMaintenance
Pulumi.AwsNative.Ec2.HostMaintenance
- Automatically allocates a new dedicated host and moves your instances on to it if a degradation is detected on your current host.
- HostRecovery
Pulumi.AwsNative.Ec2.HostRecovery
- Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default.
- InstanceFamily
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.
- InstanceType
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.
- OutpostArn
string
- The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host.
- Tags
List<Pulumi.AwsNative.Inputs.Tag>
- Any tags assigned to the Host.
- AvailabilityZone
string
- The Availability Zone in which to allocate the Dedicated Host.
- AssetId
string
- The ID of the Outpost hardware asset.
- AutoPlacement
HostAutoPlacement
- 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.
- HostMaintenance
HostMaintenance
- Automatically allocates a new dedicated host and moves your instances on to it if a degradation is detected on your current host.
- HostRecovery
HostRecovery
- Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default.
- InstanceFamily
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.
- InstanceType
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.
- OutpostArn
string
- The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host.
- Tags
TagArgs
- Any tags assigned to the Host.
- availability_zone
string
- The Availability Zone in which to allocate the Dedicated Host.
- asset_id
string
- The ID of the Outpost hardware asset.
- auto_placement
"on" | "off"
- 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.
- host_maintenance
"on" | "off"
- Automatically allocates a new dedicated host and moves your instances on to it if a degradation is detected on your current host.
- host_recovery
"on" | "off"
- Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default.
- instance_family
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.
- instance_type
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.
- outpost_arn
string
- The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host.
- tags
list(object)
- Any tags assigned to the Host.
- availabilityZone
String
- The Availability Zone in which to allocate the Dedicated Host.
- assetId
String
- The ID of the Outpost hardware asset.
- autoPlacement
HostAutoPlacement
- 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.
- hostMaintenance
HostMaintenance
- Automatically allocates a new dedicated host and moves your instances on to it if a degradation is detected on your current host.
- hostRecovery
HostRecovery
- Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default.
- instanceFamily
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.
- instanceType
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.
- outpostArn
String
- The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host.
- tags
List<Tag>
- Any tags assigned to the Host.
- availabilityZone
string
- The Availability Zone in which to allocate the Dedicated Host.
- assetId
string
- The ID of the Outpost hardware asset.
- autoPlacement
HostAutoPlacement
- 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.
- hostMaintenance
HostMaintenance
- Automatically allocates a new dedicated host and moves your instances on to it if a degradation is detected on your current host.
- hostRecovery
HostRecovery
- Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default.
- instanceFamily
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.
- instanceType
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.
- outpostArn
string
- The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host.
- tags
Tag[]
- Any tags assigned to the Host.
- availability_zone
str
- The Availability Zone in which to allocate the Dedicated Host.
- asset_id
str
- The ID of the Outpost hardware asset.
- auto_placement
HostAutoPlacement
- 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.
- host_maintenance
HostMaintenance
- Automatically allocates a new dedicated host and moves your instances on to it if a degradation is detected on your current host.
- host_recovery
HostRecovery
- Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default.
- instance_family
str
- 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.
- instance_type
str
- 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.
- outpost_arn
str
- The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host.
- tags
Sequence[TagArgs]
- Any tags assigned to the Host.
- availabilityZone
String
- The Availability Zone in which to allocate the Dedicated Host.
- assetId
String
- The ID of the Outpost hardware asset.
- autoPlacement
"on" | "off"
- 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.
- hostMaintenance
"on" | "off"
- Automatically allocates a new dedicated host and moves your instances on to it if a degradation is detected on your current host.
- hostRecovery
"on" | "off"
- Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default.
- instanceFamily
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.
- instanceType
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.
- outpostArn
String
- The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host.
- tags
List<Property Map>
- Any tags assigned to the Host.
Outputs
All input properties are implicitly available as output properties. Additionally, the Host resource produces the following output properties:
- HostId
string
- ID of the host created.
- Id
string
- The provider-assigned unique ID for this managed resource.
- HostId
string
- ID of the host created.
- Id
string
- The provider-assigned unique ID for this managed resource.
- host_id
string
- ID of the host created.
- id
string
- The provider-assigned unique ID for this managed resource.
- hostId
String
- ID of the host created.
- id
String
- The provider-assigned unique ID for this managed resource.
- hostId
string
- ID of the host created.
- id
string
- The provider-assigned unique ID for this managed resource.
- host_id
str
- ID of the host created.
- id
str
- The provider-assigned unique ID for this managed resource.
- hostId
String
- ID of the host created.
- id
String
- The provider-assigned unique ID for this managed resource.
Look up Existing Host Resource
Get an existing Host resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static Host get(String name, Output<String> id, CustomResourceOptions options)
resources: existingHost: type: aws-native:ec2:Host get: id: ${id}
import {
to = aws-native_ec2_host.example
id = "${id}"
}
- name
string
- The unique name of the resulting resource.
- id
Input<ID>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
str
- The unique name of the resulting resource.
- id
str
- The unique provider ID of the resource to look up.
- opts
ResourceOptions
- Bag of options to control resource's behavior.
- ctx
Context
- Context object for the current deployment.
- name
string
- The unique name of the resulting resource.
- id
IDInput
- The unique provider ID of the resource to look up.
- state
HostState
- Pass nil. This resource has no state arguments.
- opts
ResourceOption
- Bag of options to control resource's behavior.
- name
string
- The unique name of the resulting resource.
- id
Input<string>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- name
String
- The unique name of the resulting resource.
- id
Output<String>
- The unique provider ID of the resource to look up.
- options
CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
HostAutoPlacement
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.
| Name | Value |
|---|
| HostAutoPlacementOn | on |
| HostAutoPlacementOff | off |
HostMaintenance
Automatically allocates a new dedicated host and moves your instances on to it if a degradation is detected on your current host.
| Name | Value |
|---|
| HostMaintenanceOn | on |
| HostMaintenanceOff | off |
HostRecovery
Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default.
| Name | Value |
|---|
| HostRecoveryOn | on |
| HostRecoveryOff | off |
Tag, TagArgs
A set of tags to apply to the resource.
- 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
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