@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
177 lines (176 loc) • 7.09 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as enums from "../types/enums";
/**
* Provides an EC2 placement group. Read more about placement groups
* in [AWS Docs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const web = new aws.ec2.PlacementGroup("web", {
* name: "hunky-dory-pg",
* strategy: aws.ec2.PlacementStrategy.Cluster,
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import placement groups using the `name`. For example:
*
* ```sh
* $ pulumi import aws:ec2/placementGroup:PlacementGroup prod_pg production-placement-group
* ```
*/
export declare class PlacementGroup extends pulumi.CustomResource {
/**
* Get an existing PlacementGroup 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?: PlacementGroupState, opts?: pulumi.CustomResourceOptions): PlacementGroup;
/**
* Returns true if the given object is an instance of PlacementGroup. 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 PlacementGroup;
/**
* Amazon Resource Name (ARN) of the placement group.
*/
readonly arn: pulumi.Output<string>;
/**
* The name of the placement group.
*/
readonly name: pulumi.Output<string>;
/**
* The number of partitions to create in the
* placement group. Can only be specified when the `strategy` is set to
* `partition`. Valid values are 1 - 7 (default is `2`).
*/
readonly partitionCount: pulumi.Output<number>;
/**
* The ID of the placement group.
*/
readonly placementGroupId: 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>;
/**
* Determines how placement groups spread instances. Can only be used
* when the `strategy` is set to `spread`. Can be `host` or `rack`. `host` can only be used for Outpost placement groups. Defaults to `rack`.
*/
readonly spreadLevel: pulumi.Output<string>;
/**
* The placement strategy. Can be `cluster`, `partition` or `spread`.
*/
readonly strategy: pulumi.Output<string>;
/**
* Key-value map of resource tags. .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 PlacementGroup 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: PlacementGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering PlacementGroup resources.
*/
export interface PlacementGroupState {
/**
* Amazon Resource Name (ARN) of the placement group.
*/
arn?: pulumi.Input<string>;
/**
* The name of the placement group.
*/
name?: pulumi.Input<string>;
/**
* The number of partitions to create in the
* placement group. Can only be specified when the `strategy` is set to
* `partition`. Valid values are 1 - 7 (default is `2`).
*/
partitionCount?: pulumi.Input<number>;
/**
* The ID of the placement group.
*/
placementGroupId?: 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>;
/**
* Determines how placement groups spread instances. Can only be used
* when the `strategy` is set to `spread`. Can be `host` or `rack`. `host` can only be used for Outpost placement groups. Defaults to `rack`.
*/
spreadLevel?: pulumi.Input<string>;
/**
* The placement strategy. Can be `cluster`, `partition` or `spread`.
*/
strategy?: pulumi.Input<string | enums.ec2.PlacementStrategy>;
/**
* Key-value map of resource tags. .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 PlacementGroup resource.
*/
export interface PlacementGroupArgs {
/**
* The name of the placement group.
*/
name?: pulumi.Input<string>;
/**
* The number of partitions to create in the
* placement group. Can only be specified when the `strategy` is set to
* `partition`. Valid values are 1 - 7 (default is `2`).
*/
partitionCount?: pulumi.Input<number>;
/**
* 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>;
/**
* Determines how placement groups spread instances. Can only be used
* when the `strategy` is set to `spread`. Can be `host` or `rack`. `host` can only be used for Outpost placement groups. Defaults to `rack`.
*/
spreadLevel?: pulumi.Input<string>;
/**
* The placement strategy. Can be `cluster`, `partition` or `spread`.
*/
strategy: pulumi.Input<string | enums.ec2.PlacementStrategy>;
/**
* Key-value map of resource tags. .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>;
}>;
}