getEndpoint

AWS v6 v6.83.2, Nov 20 25

AWS v6 v6.83.2 published on Thursday, Nov 20, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-aws

AWS v6 v6.83.2 published on Thursday, Nov 20, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-aws

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  agent:
    type: kubernetes:core/v1:Pod
    properties:
      metadata:
        name: my-device
      spec:
        container:
          - image: gcr.io/my-project/image-name
            name: image-name
            env:
              - name: IOT_ENDPOINT
                value: ${example.endpointAddress}
variables:
  example:
    fn::invoke:
      function: aws:iot:getEndpoint
      arguments: {}

Using getEndpoint

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getEndpoint(args: GetEndpointArgs, opts?: InvokeOptions): Promise<GetEndpointResult>
function getEndpointOutput(args: GetEndpointOutputArgs, opts?: InvokeOptions): Output<GetEndpointResult>

def get_endpoint(endpoint_type: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetEndpointResult
def get_endpoint_output(endpoint_type: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetEndpointResult]

func GetEndpoint(ctx *Context, args *GetEndpointArgs, opts ...InvokeOption) (*GetEndpointResult, error)
func GetEndpointOutput(ctx *Context, args *GetEndpointOutputArgs, opts ...InvokeOption) GetEndpointResultOutput

> Note: This function is named GetEndpoint in the Go SDK.

public static class GetEndpoint 
{
    public static Task<GetEndpointResult> InvokeAsync(GetEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetEndpointResult> Invoke(GetEndpointInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetEndpointResult> getEndpoint(GetEndpointArgs args, InvokeOptions options)
public static Output<GetEndpointResult> getEndpoint(GetEndpointArgs args, InvokeOptions options)

fn::invoke:
  function: aws:iot/getEndpoint:getEndpoint
  arguments:
    # arguments dictionary

The following arguments are supported:

EndpointType string: Endpoint type. Valid values: iot:CredentialProvider, iot:Data, iot:Data-ATS, iot:Jobs.

EndpointType string: Endpoint type. Valid values: iot:CredentialProvider, iot:Data, iot:Data-ATS, iot:Jobs.

endpointType String: Endpoint type. Valid values: iot:CredentialProvider, iot:Data, iot:Data-ATS, iot:Jobs.

endpointType string: Endpoint type. Valid values: iot:CredentialProvider, iot:Data, iot:Data-ATS, iot:Jobs.

endpoint_type str: Endpoint type. Valid values: iot:CredentialProvider, iot:Data, iot:Data-ATS, iot:Jobs.

endpointType String: Endpoint type. Valid values: iot:CredentialProvider, iot:Data, iot:Data-ATS, iot:Jobs.

getEndpoint Result

The following output properties are available:

EndpointAddress string

Endpoint based on endpoint_type:

No endpoint_type: Either iot:Data or iot:Data-ATS depending on region
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

Id string