@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
217 lines (216 loc) • 6.3 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* The ECS Service data source allows access to details of a specific
* Service within a AWS ECS Cluster.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.ecs.getService({
* serviceName: "example",
* clusterArn: exampleAwsEcsCluster.arn,
* });
* ```
*/
export declare function getService(args: GetServiceArgs, opts?: pulumi.InvokeOptions): Promise<GetServiceResult>;
/**
* A collection of arguments for invoking getService.
*/
export interface GetServiceArgs {
/**
* ARN of the ECS Cluster
*/
clusterArn: 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;
/**
* Name of the ECS Service
*/
serviceName: string;
/**
* Resource tags.
*/
tags?: {
[key: string]: string;
};
}
/**
* A collection of values returned by getService.
*/
export interface GetServiceResult {
/**
* ARN of the task set
*/
readonly arn: string;
/**
* Whether Availability Zone rebalancing is enabled
*/
readonly availabilityZoneRebalancing: string;
/**
* Capacity provider strategy for the service. See `capacityProviderStrategy` Block for details.
*/
readonly capacityProviderStrategies: outputs.ecs.GetServiceCapacityProviderStrategy[];
readonly clusterArn: string;
/**
* Time when task set was created (RFC3339 format)
*/
readonly createdAt: string;
/**
* Principal that created the service
*/
readonly createdBy: string;
/**
* Deployment configuration for the service. See `deploymentConfiguration` Block for details.
*/
readonly deploymentConfigurations: outputs.ecs.GetServiceDeploymentConfiguration[];
/**
* Deployment controller configuration. See `deploymentController` Block for details.
*/
readonly deploymentControllers: outputs.ecs.GetServiceDeploymentController[];
/**
* Current deployments for the service. See `deployments` Block for details.
*/
readonly deployments: outputs.ecs.GetServiceDeployment[];
/**
* Desired number of tasks
*/
readonly desiredCount: number;
/**
* Whether ECS managed tags are enabled
*/
readonly enableEcsManagedTags: boolean;
/**
* Whether execute command functionality is enabled
*/
readonly enableExecuteCommand: boolean;
/**
* Recent service events. See `events` Block for details.
*/
readonly events: outputs.ecs.GetServiceEvent[];
/**
* Grace period for health checks
*/
readonly healthCheckGracePeriodSeconds: number;
/**
* ARN of the IAM role associated with the service
*/
readonly iamRole: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* Launch type for the ECS Service
*/
readonly launchType: string;
/**
* Load balancers for the ECS Service. See `loadBalancer` Block for details.
*/
readonly loadBalancers: outputs.ecs.GetServiceLoadBalancer[];
/**
* Network configuration for the service. See `networkConfiguration` Block for details.
*/
readonly networkConfigurations: outputs.ecs.GetServiceNetworkConfiguration[];
/**
* Placement strategy for tasks. See `orderedPlacementStrategy` Block for details.
*/
readonly orderedPlacementStrategies: outputs.ecs.GetServiceOrderedPlacementStrategy[];
/**
* Number of pending tasks
*/
readonly pendingCount: number;
/**
* Placement constraints for tasks. See `placementConstraints` Block for details.
*/
readonly placementConstraints: outputs.ecs.GetServicePlacementConstraint[];
/**
* Platform family for Fargate tasks
*/
readonly platformFamily: string;
/**
* Platform version for Fargate tasks
*/
readonly platformVersion: string;
/**
* Whether tags are propagated from task definition or service
*/
readonly propagateTags: string;
readonly region: string;
/**
* Number of running tasks
*/
readonly runningCount: number;
/**
* Scheduling strategy for the ECS Service
*/
readonly schedulingStrategy: string;
readonly serviceName: string;
/**
* Service discovery registries. See `serviceRegistries` Block for details.
*/
readonly serviceRegistries: outputs.ecs.GetServiceServiceRegistry[];
/**
* Task set status
*/
readonly status: string;
/**
* Resource tags.
*/
readonly tags: {
[key: string]: string;
};
/**
* Task definition ARN
*/
readonly taskDefinition: string;
/**
* Task sets for the service. See `taskSets` Block for details.
*/
readonly taskSets: outputs.ecs.GetServiceTaskSet[];
}
/**
* The ECS Service data source allows access to details of a specific
* Service within a AWS ECS Cluster.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.ecs.getService({
* serviceName: "example",
* clusterArn: exampleAwsEcsCluster.arn,
* });
* ```
*/
export declare function getServiceOutput(args: GetServiceOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetServiceResult>;
/**
* A collection of arguments for invoking getService.
*/
export interface GetServiceOutputArgs {
/**
* ARN of the ECS Cluster
*/
clusterArn: 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>;
/**
* Name of the ECS Service
*/
serviceName: pulumi.Input<string>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}