getEndpoint

Returns a unique endpoint specific to the AWS account making the call.

Using getEndpoint

function getEndpoint(args: GetEndpointArgs, opts?: InvokeOptions): Promise<GetEndpointResult>
def get_endpoint(endpoint_type: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetEndpointResult
func GetEndpoint(ctx *Context, args *GetEndpointArgs, opts ...InvokeOption) (*GetEndpointResult, error)

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

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

The following arguments are supported:

EndpointType string
Endpoint type. Valid values: iot:CredentialProvider, iot:Data, iot:Data-ATS, iot:Job.
EndpointType string
Endpoint type. Valid values: iot:CredentialProvider, iot:Data, iot:Data-ATS, iot:Job.
endpointType string
Endpoint type. Valid values: iot:CredentialProvider, iot:Data, iot:Data-ATS, iot:Job.
endpoint_type str
Endpoint type. Valid values: iot:CredentialProvider, iot:Data, iot:Data-ATS, iot:Job.

getEndpoint Result

The following output properties are available:

EndpointAddress string

The 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:Job: IDENTIFIER.jobs.iot.REGION.amazonaws.com
Id string
The provider-assigned unique ID for this managed resource.
EndpointType string
EndpointAddress string

The 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:Job: IDENTIFIER.jobs.iot.REGION.amazonaws.com
Id string
The provider-assigned unique ID for this managed resource.
EndpointType string
endpointAddress string

The 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:Job: IDENTIFIER.jobs.iot.REGION.amazonaws.com
id string
The provider-assigned unique ID for this managed resource.
endpointType string
endpoint_address str

The 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:Job: IDENTIFIER.jobs.iot.REGION.amazonaws.com
id str
The provider-assigned unique ID for this managed resource.
endpoint_type str

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.