UNPKG

@pulumi/aws

Version:

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

122 lines (121 loc) 4.11 kB
import * as pulumi from "@pulumi/pulumi"; import * as outputs from "../types/output"; /** * Retrieves information about a Service Discovery Service. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const test = aws.servicediscovery.getService({ * name: "example", * namespaceId: "NAMESPACE_ID_VALUE", * }); * ``` */ export declare function getService(args: GetServiceArgs, opts?: pulumi.InvokeOptions): Promise<GetServiceResult>; /** * A collection of arguments for invoking getService. */ export interface GetServiceArgs { /** * Name of the service. */ name: string; /** * ID of the namespace that the service belongs to. */ namespaceId: 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; /** * Map of tags to assign to the service. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. */ tags?: { [key: string]: string; }; } /** * A collection of values returned by getService. */ export interface GetServiceResult { /** * ARN of the service. */ readonly arn: string; /** * Description of the service. */ readonly description: string; /** * Complex type that contains information about the resource record sets that you want Amazon Route 53 to create when you register an instance. See `dnsConfig` Block for details. */ readonly dnsConfigs: outputs.servicediscovery.GetServiceDnsConfig[]; /** * Complex type that contains settings for an optional health check. Only for Public DNS namespaces. See `healthCheckConfig` Block for details. */ readonly healthCheckConfigs: outputs.servicediscovery.GetServiceHealthCheckConfig[]; /** * A complex type that contains settings for ECS managed health checks. See `healthCheckCustomConfig` Block for details. */ readonly healthCheckCustomConfigs: outputs.servicediscovery.GetServiceHealthCheckCustomConfig[]; /** * The provider-assigned unique ID for this managed resource. */ readonly id: string; readonly name: string; /** * ID of the namespace to use for DNS configuration. */ readonly namespaceId: string; readonly region: string; /** * Map of tags to assign to the service. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. */ readonly tags?: { [key: string]: string; }; } /** * Retrieves information about a Service Discovery Service. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const test = aws.servicediscovery.getService({ * name: "example", * namespaceId: "NAMESPACE_ID_VALUE", * }); * ``` */ export declare function getServiceOutput(args: GetServiceOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetServiceResult>; /** * A collection of arguments for invoking getService. */ export interface GetServiceOutputArgs { /** * Name of the service. */ name: pulumi.Input<string>; /** * ID of the namespace that the service belongs to. */ namespaceId: 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 the service. 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>; }>; }