Package com.pulumi.aws.iot

Class Authorizer

  • public class Authorizer
extends com.pulumi.resources.CustomResource
    Creates and manages an AWS IoT Authorizer. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.iot.Authorizer;
 import com.pulumi.aws.iot.AuthorizerArgs;
 import com.pulumi.std.StdFunctions;
 import com.pulumi.std.inputs.FileArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 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) {
         var example = new Authorizer("example", AuthorizerArgs.builder()
             .name("example")
             .authorizerFunctionArn(exampleAwsLambdaFunction.arn())
             .signingDisabled(false)
             .status("ACTIVE")
             .tokenKeyName("Token-Header")
             .tokenSigningPublicKeys(Map.of("Key1", StdFunctions.file(FileArgs.builder()
                 .input("test-fixtures/iot-authorizer-signing-key.pem")
                 .build()).result()))
             .tags(Map.of("Name", "example"))
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import IoT Authorizers using the name. For example: ```sh $ pulumi import aws:iot/authorizer:Authorizer example example ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> authorizerFunctionArn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enableCachingForHttp()  
      static Authorizer get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, AuthorizerState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> signingDisabled()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> status()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> tokenKeyName()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tokenSigningPublicKeys()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Authorizer

        public Authorizer​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Authorizer

        public Authorizer​(java.lang.String name,
                  AuthorizerArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Authorizer

        public Authorizer​(java.lang.String name,
                  AuthorizerArgs args,
                  @Nullable
                  com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        The ARN of the authorizer.

      • authorizerFunctionArn

        public com.pulumi.core.Output<java.lang.String> authorizerFunctionArn()
        Returns:
        The ARN of the authorizer's Lambda function.

      • enableCachingForHttp

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enableCachingForHttp()
        Returns:
        Specifies whether the HTTP caching is enabled or not. Default: `false`.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        The name of the authorizer.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        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.

      • signingDisabled

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> signingDisabled()
        Returns:
        Specifies whether AWS IoT validates the token signature in an authorization request. Default: `false`.

      • status

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> status()
        Returns:
        The status of Authorizer request at creation. Valid values: `ACTIVE`, `INACTIVE`. Default: `ACTIVE`.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to this resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • tokenKeyName

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> tokenKeyName()
        Returns:
        The name of the token key used to extract the token from the HTTP headers. This value is required if signing is enabled in your authorizer.

      • tokenSigningPublicKeys

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tokenSigningPublicKeys()
        Returns:
        The public keys used to verify the digital signature returned by your custom authentication service. This value is required if signing is enabled in your authorizer.

      • get

        public static Authorizer get​(java.lang.String name,
                             com.pulumi.core.Output<java.lang.String> id,
                             @Nullable
                             AuthorizerState state,
                             @Nullable
                             com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.