@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
157 lines (156 loc) • 9.48 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.htmlin the Amazon Elastic Container Service Developer Guide.
*/
export declare class TaskSet extends pulumi.CustomResource {
/**
* Get an existing TaskSet 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 opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): TaskSet;
/**
* Returns true if the given object is an instance of TaskSet. 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 TaskSet;
/**
* The ID of the task set.
*/
readonly awsId: pulumi.Output<string>;
/**
* The capacity provider strategy that are associated with the task set.
*/
readonly capacityProviderStrategy: pulumi.Output<outputs.ecs.TaskSetCapacityProviderStrategyItem[] | undefined>;
/**
* The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
*/
readonly cluster: pulumi.Output<string>;
/**
* An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value.
*/
readonly externalId: pulumi.Output<string | undefined>;
/**
* The launch type that new tasks in the task set will use. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html in the Amazon Elastic Container Service Developer Guide.
*/
readonly launchType: pulumi.Output<enums.ecs.TaskSetLaunchType | undefined>;
/**
* A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.
*/
readonly loadBalancers: pulumi.Output<outputs.ecs.TaskSetLoadBalancer[] | undefined>;
/**
* The network configuration for the task set.
*/
readonly networkConfiguration: pulumi.Output<outputs.ecs.TaskSetNetworkConfiguration | undefined>;
/**
* The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default.
*/
readonly platformVersion: pulumi.Output<string | undefined>;
/**
* A floating-point percentage of the desired number of tasks to place and keep running in the task set.
*/
readonly scale: pulumi.Output<outputs.ecs.TaskSetScale | undefined>;
/**
* The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
*/
readonly service: pulumi.Output<string>;
/**
* The details of the service discovery registries to assign to this task set. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html.
*/
readonly serviceRegistries: pulumi.Output<outputs.ecs.TaskSetServiceRegistry[] | undefined>;
/**
* The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.
*
* The following basic restrictions apply to tags:
*
* - Maximum number of tags per resource - 50
* - For each resource, each tag key must be unique, and each tag key can have only one value.
* - Maximum key length - 128 Unicode characters in UTF-8
* - Maximum value length - 256 Unicode characters in UTF-8
* - If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
* - Tag keys and values are case-sensitive.
* - Do not use `aws:` , `AWS:` , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
*/
readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* The short name or full Amazon Resource Name (ARN) of the task definition for the tasks in the task set to use.
*/
readonly taskDefinition: pulumi.Output<string>;
/**
* Create a TaskSet 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: TaskSetArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a TaskSet resource.
*/
export interface TaskSetArgs {
/**
* The capacity provider strategy that are associated with the task set.
*/
capacityProviderStrategy?: pulumi.Input<pulumi.Input<inputs.ecs.TaskSetCapacityProviderStrategyItemArgs>[]>;
/**
* The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
*/
cluster: pulumi.Input<string>;
/**
* An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value.
*/
externalId?: pulumi.Input<string>;
/**
* The launch type that new tasks in the task set will use. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html in the Amazon Elastic Container Service Developer Guide.
*/
launchType?: pulumi.Input<enums.ecs.TaskSetLaunchType>;
/**
* A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.
*/
loadBalancers?: pulumi.Input<pulumi.Input<inputs.ecs.TaskSetLoadBalancerArgs>[]>;
/**
* The network configuration for the task set.
*/
networkConfiguration?: pulumi.Input<inputs.ecs.TaskSetNetworkConfigurationArgs>;
/**
* The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default.
*/
platformVersion?: pulumi.Input<string>;
/**
* A floating-point percentage of the desired number of tasks to place and keep running in the task set.
*/
scale?: pulumi.Input<inputs.ecs.TaskSetScaleArgs>;
/**
* The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
*/
service: pulumi.Input<string>;
/**
* The details of the service discovery registries to assign to this task set. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html.
*/
serviceRegistries?: pulumi.Input<pulumi.Input<inputs.ecs.TaskSetServiceRegistryArgs>[]>;
/**
* The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.
*
* The following basic restrictions apply to tags:
*
* - Maximum number of tags per resource - 50
* - For each resource, each tag key must be unique, and each tag key can have only one value.
* - Maximum key length - 128 Unicode characters in UTF-8
* - Maximum value length - 256 Unicode characters in UTF-8
* - If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
* - Tag keys and values are case-sensitive.
* - Do not use `aws:` , `AWS:` , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
/**
* The short name or full Amazon Resource Name (ARN) of the task definition for the tasks in the task set to use.
*/
taskDefinition: pulumi.Input<string>;
}