@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
106 lines (105 loc) • 3.52 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Returns a unique endpoint specific to the AWS account making the call.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* import * as kubernetes from "@pulumi/kubernetes";
*
* const example = aws.iot.getEndpoint({});
* const agent = new kubernetes.index.Pod("agent", {
* metadata: [{
* name: "my-device",
* }],
* spec: [{
* container: [{
* image: "gcr.io/my-project/image-name",
* name: "image-name",
* env: [{
* name: "IOT_ENDPOINT",
* value: example.endpointAddress,
* }],
* }],
* }],
* });
* ```
*/
export declare function getEndpoint(args?: GetEndpointArgs, opts?: pulumi.InvokeOptions): Promise<GetEndpointResult>;
/**
* A collection of arguments for invoking getEndpoint.
*/
export interface GetEndpointArgs {
/**
* Endpoint type. Valid values: `iot:CredentialProvider`, `iot:Data`, `iot:Data-ATS`, `iot:Jobs`.
*/
endpointType?: 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;
}
/**
* A collection of values returned by getEndpoint.
*/
export interface GetEndpointResult {
/**
* Endpoint based on `endpointType`:
* * No `endpointType`: Either `iot:Data` or `iot:Data-ATS` [depending on region](https://aws.amazon.com/blogs/iot/aws-iot-core-ats-endpoints/)
* * `iot:CredentialsProvider`: `IDENTIFIER.credentials.iot.REGION.amazonaws.com`
* * `iot:Data`: `IDENTIFIER.iot.REGION.amazonaws.com`
* * `iot:Data-ATS`: `IDENTIFIER-ats.iot.REGION.amazonaws.com`
* * `iot:Jobs`: `IDENTIFIER.jobs.iot.REGION.amazonaws.com`
*/
readonly endpointAddress: string;
readonly endpointType?: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly region: string;
}
/**
* Returns a unique endpoint specific to the AWS account making the call.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* import * as kubernetes from "@pulumi/kubernetes";
*
* const example = aws.iot.getEndpoint({});
* const agent = new kubernetes.index.Pod("agent", {
* metadata: [{
* name: "my-device",
* }],
* spec: [{
* container: [{
* image: "gcr.io/my-project/image-name",
* name: "image-name",
* env: [{
* name: "IOT_ENDPOINT",
* value: example.endpointAddress,
* }],
* }],
* }],
* });
* ```
*/
export declare function getEndpointOutput(args?: GetEndpointOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetEndpointResult>;
/**
* A collection of arguments for invoking getEndpoint.
*/
export interface GetEndpointOutputArgs {
/**
* Endpoint type. Valid values: `iot:CredentialProvider`, `iot:Data`, `iot:Data-ATS`, `iot:Jobs`.
*/
endpointType?: 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>;
}