Authorizer class

Creates and manages an AWS IoT Authorizer.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
import * as std from "@pulumi/std";

const example = new aws.iot.Authorizer("example", {
    name: "example",
    authorizerFunctionArn: exampleAwsLambdaFunction.arn,
    signingDisabled: false,
    status: "ACTIVE",
    tokenKeyName: "Token-Header",
    tokenSigningPublicKeys: {
        Key1: std.file({
            input: "test-fixtures/iot-authorizer-signing-key.pem",
        }).then(invoke => invoke.result),
    },
    tags: {
        Name: "example",
    },
});
import pulumi
import pulumi_aws as aws
import pulumi_std as std

example = aws.iot.Authorizer("example",
    name="example",
    authorizer_function_arn=example_aws_lambda_function["arn"],
    signing_disabled=False,
    status="ACTIVE",
    token_key_name="Token-Header",
    token_signing_public_keys={
        "Key1": std.file(input="test-fixtures/iot-authorizer-signing-key.pem").result,
    },
    tags={
        "Name": "example",
    })
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
using Std = Pulumi.Std;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Iot.Authorizer("example", new()
    {
        Name = "example",
        AuthorizerFunctionArn = exampleAwsLambdaFunction.Arn,
        SigningDisabled = false,
        Status = "ACTIVE",
        TokenKeyName = "Token-Header",
        TokenSigningPublicKeys =
        {
            { "Key1", Std.File.Invoke(new()
            {
                Input = "test-fixtures/iot-authorizer-signing-key.pem",
            }).Apply(invoke => invoke.Result) },
        },
        Tags =
        {
            { "Name", "example" },
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/iot"
	"github.com/pulumi/pulumi-std/sdk/go/std"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		invokeFile, err := std.File(ctx, &std.FileArgs{
			Input: "test-fixtures/iot-authorizer-signing-key.pem",
		}, nil)
		if err != nil {
			return err
		}
		_, err = iot.NewAuthorizer(ctx, "example", &iot.AuthorizerArgs{
			Name:                  pulumi.String("example"),
			AuthorizerFunctionArn: pulumi.Any(exampleAwsLambdaFunction.Arn),
			SigningDisabled:       pulumi.Bool(false),
			Status:                pulumi.String("ACTIVE"),
			TokenKeyName:          pulumi.String("Token-Header"),
			TokenSigningPublicKeys: pulumi.StringMap{
				"Key1": pulumi.String(invokeFile.Result),
			},
			Tags: pulumi.StringMap{
				"Name": pulumi.String("example"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
    std = {
      source = "pulumi/std"
    }
  }
}

resource "aws_iot_authorizer" "example" {
  name                    = "example"
  authorizer_function_arn = exampleAwsLambdaFunction.arn
  signing_disabled        = false
  status                  = "ACTIVE"
  token_key_name          = "Token-Header"
  token_signing_public_keys = {
    "Key1" = file("test-fixtures/iot-authorizer-signing-key.pem")
  }
  tags = {
    "Name" = "example"
  }
}
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());

    }
}
resources:
  example:
    type: aws:iot:Authorizer
    properties:
      name: example
      authorizerFunctionArn: ${exampleAwsLambdaFunction.arn}
      signingDisabled: false
      status: ACTIVE
      tokenKeyName: Token-Header
      tokenSigningPublicKeys:
        Key1:
          fn::invoke:
            function: std:file
            arguments:
              input: test-fixtures/iot-authorizer-signing-key.pem
            return: result
      tags:
        Name: example

Import

Using pulumi import, import IOT Authorizers using the name. For example:

$ pulumi import aws:iot/authorizer:Authorizer example example

Constructors

Authorizer(String name, {AuthorizerArgs? args, CustomResourceOptions? options})
Creates a new Authorizer. name The Pulumi resource name. args Arguments used to configure this Authorizer. The set of arguments for Authorizer. options Resource options controlling this resource's behavior.
Authorizer.reference(String urn)
Creates a typed reference to an existing Authorizer resource.

Properties

arn ↔ Output<String>
The ARN of the authorizer.
latefinal
authorizerFunctionArn ↔ Output<String>
The ARN of the authorizer's Lambda function.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
enableCachingForHttp ↔ Output<bool?>
Specifies whether the HTTP caching is enabled or not. Default: false.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>
The name of the authorizer.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
signingDisabled ↔ Output<bool?>
Specifies whether AWS IoT validates the token signature in an authorization request. Default: false.
latefinal
status ↔ Output<String?>
The status of Authorizer request at creation. Valid values: ACTIVE, INACTIVE. Default: ACTIVE.
latefinal
tags ↔ Output<Map<String, String>?>
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.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
tokenKeyName ↔ Output<String?>
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.
latefinal
tokenSigningPublicKeys ↔ Output<Map<String, String>?>
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.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {AuthorizerState? state, CustomResourceOptions? options}) → Authorizer
Gets an existing Authorizer resource's state with the given name and id.