1. Packages
  2. AWS Classic
  3. API Docs
  4. iot
  5. getEndpoint

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi

aws.iot.getEndpoint

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi

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

    Example Usage

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.iot.IotFunctions;
    import com.pulumi.aws.iot.inputs.GetEndpointArgs;
    import com.pulumi.kubernetes.core_v1.Pod;
    import com.pulumi.kubernetes.core_v1.PodArgs;
    import com.pulumi.kubernetes.meta_v1.inputs.ObjectMetaArgs;
    import com.pulumi.kubernetes.core_v1.inputs.PodSpecArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var example = IotFunctions.getEndpoint();
    
            var agent = new Pod("agent", PodArgs.builder()
                .metadata(ObjectMetaArgs.builder()
                    .name("my-device")
                    .build())
                .spec(PodSpecArgs.builder()
                    .container(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                    .build())
                .build());
    
        }
    }
    
    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)
    // Output-based functions aren't available in Java yet
    
    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
    The provider-assigned unique ID for this managed resource.
    EndpointType string
    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
    The provider-assigned unique ID for this managed resource.
    EndpointType string
    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
    The provider-assigned unique ID for this managed resource.
    endpointType String
    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
    The provider-assigned unique ID for this managed resource.
    endpointType string
    endpoint_address str
    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 str
    The provider-assigned unique ID for this managed resource.
    endpoint_type str
    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
    The provider-assigned unique ID for this managed resource.
    endpointType String

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi