aws.iot.getEndpoint
Returns a unique endpoint specific to the AWS account making the call.
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws:iot/getEndpoint:getEndpoint
arguments:
# arguments dictionary
The following arguments are supported:
- Endpoint
Type string Endpoint type. Valid values:
iot:CredentialProvider
,iot:Data
,iot:Data-ATS
,iot:Jobs
.
- Endpoint
Type string Endpoint type. Valid values:
iot:CredentialProvider
,iot:Data
,iot:Data-ATS
,iot:Jobs
.
- endpoint
Type String Endpoint type. Valid values:
iot:CredentialProvider
,iot:Data
,iot:Data-ATS
,iot:Jobs
.
- endpoint
Type 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
.
- endpoint
Type String Endpoint type. Valid values:
iot:CredentialProvider
,iot:Data
,iot:Data-ATS
,iot:Jobs
.
getEndpoint Result
The following output properties are available:
- Endpoint
Address string Endpoint based on
endpoint_type
:- No
endpoint_type
: Eitheriot:Data
oriot: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
- No
- Id string
The provider-assigned unique ID for this managed resource.
- Endpoint
Type string
- Endpoint
Address string Endpoint based on
endpoint_type
:- No
endpoint_type
: Eitheriot:Data
oriot: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
- No
- Id string
The provider-assigned unique ID for this managed resource.
- Endpoint
Type string
- endpoint
Address String Endpoint based on
endpoint_type
:- No
endpoint_type
: Eitheriot:Data
oriot: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
- No
- id String
The provider-assigned unique ID for this managed resource.
- endpoint
Type String
- endpoint
Address string Endpoint based on
endpoint_type
:- No
endpoint_type
: Eitheriot:Data
oriot: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
- No
- id string
The provider-assigned unique ID for this managed resource.
- endpoint
Type string
- endpoint_
address str Endpoint based on
endpoint_type
:- No
endpoint_type
: Eitheriot:Data
oriot: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
- No
- id str
The provider-assigned unique ID for this managed resource.
- endpoint_
type str
- endpoint
Address String Endpoint based on
endpoint_type
:- No
endpoint_type
: Eitheriot:Data
oriot: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
- No
- id String
The provider-assigned unique ID for this managed resource.
- endpoint
Type String
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.