Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. iot
  5. getAuthorizer

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.iot.getAuthorizer

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    Creates an authorizer.

    Using getAuthorizer

    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 getAuthorizer(args: GetAuthorizerArgs, opts?: InvokeOptions): Promise<GetAuthorizerResult>
function getAuthorizerOutput(args: GetAuthorizerOutputArgs, opts?: InvokeOptions): Output<GetAuthorizerResult>
    def get_authorizer(authorizer_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetAuthorizerResult
def get_authorizer_output(authorizer_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetAuthorizerResult]
    func LookupAuthorizer(ctx *Context, args *LookupAuthorizerArgs, opts ...InvokeOption) (*LookupAuthorizerResult, error)
func LookupAuthorizerOutput(ctx *Context, args *LookupAuthorizerOutputArgs, opts ...InvokeOption) LookupAuthorizerResultOutput

    > Note: This function is named LookupAuthorizer in the Go SDK.

    public static class GetAuthorizer 
{
    public static Task<GetAuthorizerResult> InvokeAsync(GetAuthorizerArgs args, InvokeOptions? opts = null)
    public static Output<GetAuthorizerResult> Invoke(GetAuthorizerInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAuthorizerResult> getAuthorizer(GetAuthorizerArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:iot:getAuthorizer
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AuthorizerName string
    The authorizer name.
    AuthorizerName string
    The authorizer name.
    authorizerName String
    The authorizer name.
    authorizerName string
    The authorizer name.
    authorizer_name str
    The authorizer name.
    authorizerName String
    The authorizer name.

    getAuthorizer Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the authorizer.
    AuthorizerFunctionArn string
    The authorizer's Lambda function ARN.
    EnableCachingForHttp bool
    When true , the result from the authorizer's Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the time specified by the Lambda function in refreshAfterInSeconds . This value doesn't affect authorization of clients that use MQTT connections.
    Status Pulumi.AwsNative.IoT.AuthorizerStatus

    The status of the authorizer.

    Valid values: ACTIVE | INACTIVE

    Tags List<Pulumi.AwsNative.Outputs.Tag>

    Metadata which can be used to manage the custom authorizer.

    For URI Request parameters use format: ...key1=value1&key2=value2...

    For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

    For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

    TokenKeyName string
    The key used to extract the token from the HTTP headers.
    TokenSigningPublicKeys Dictionary<string, string>
    The public keys used to validate the token signature returned by your custom authentication service.
    Arn string
    The Amazon Resource Name (ARN) of the authorizer.
    AuthorizerFunctionArn string
    The authorizer's Lambda function ARN.
    EnableCachingForHttp bool
    When true , the result from the authorizer's Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the time specified by the Lambda function in refreshAfterInSeconds . This value doesn't affect authorization of clients that use MQTT connections.
    Status AuthorizerStatus

    The status of the authorizer.

    Valid values: ACTIVE | INACTIVE

    Tags Tag

    Metadata which can be used to manage the custom authorizer.

    For URI Request parameters use format: ...key1=value1&key2=value2...

    For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

    For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

    TokenKeyName string
    The key used to extract the token from the HTTP headers.
    TokenSigningPublicKeys map[string]string
    The public keys used to validate the token signature returned by your custom authentication service.
    arn String
    The Amazon Resource Name (ARN) of the authorizer.
    authorizerFunctionArn String
    The authorizer's Lambda function ARN.
    enableCachingForHttp Boolean
    When true , the result from the authorizer's Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the time specified by the Lambda function in refreshAfterInSeconds . This value doesn't affect authorization of clients that use MQTT connections.
    status AuthorizerStatus

    The status of the authorizer.

    Valid values: ACTIVE | INACTIVE

    tags List<Tag>

    Metadata which can be used to manage the custom authorizer.

    For URI Request parameters use format: ...key1=value1&key2=value2...

    For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

    For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

    tokenKeyName String
    The key used to extract the token from the HTTP headers.
    tokenSigningPublicKeys Map<String,String>
    The public keys used to validate the token signature returned by your custom authentication service.
    arn string
    The Amazon Resource Name (ARN) of the authorizer.
    authorizerFunctionArn string
    The authorizer's Lambda function ARN.
    enableCachingForHttp boolean
    When true , the result from the authorizer's Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the time specified by the Lambda function in refreshAfterInSeconds . This value doesn't affect authorization of clients that use MQTT connections.
    status AuthorizerStatus

    The status of the authorizer.

    Valid values: ACTIVE | INACTIVE

    tags Tag[]

    Metadata which can be used to manage the custom authorizer.

    For URI Request parameters use format: ...key1=value1&key2=value2...

    For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

    For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

    tokenKeyName string
    The key used to extract the token from the HTTP headers.
    tokenSigningPublicKeys {[key: string]: string}
    The public keys used to validate the token signature returned by your custom authentication service.
    arn str
    The Amazon Resource Name (ARN) of the authorizer.
    authorizer_function_arn str
    The authorizer's Lambda function ARN.
    enable_caching_for_http bool
    When true , the result from the authorizer's Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the time specified by the Lambda function in refreshAfterInSeconds . This value doesn't affect authorization of clients that use MQTT connections.
    status AuthorizerStatus

    The status of the authorizer.

    Valid values: ACTIVE | INACTIVE

    tags Sequence[root_Tag]

    Metadata which can be used to manage the custom authorizer.

    For URI Request parameters use format: ...key1=value1&key2=value2...

    For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

    For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

    token_key_name str
    The key used to extract the token from the HTTP headers.
    token_signing_public_keys Mapping[str, str]
    The public keys used to validate the token signature returned by your custom authentication service.
    arn String
    The Amazon Resource Name (ARN) of the authorizer.
    authorizerFunctionArn String
    The authorizer's Lambda function ARN.
    enableCachingForHttp Boolean
    When true , the result from the authorizer's Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the time specified by the Lambda function in refreshAfterInSeconds . This value doesn't affect authorization of clients that use MQTT connections.
    status "ACTIVE" | "INACTIVE"

    The status of the authorizer.

    Valid values: ACTIVE | INACTIVE

    tags List<Property Map>

    Metadata which can be used to manage the custom authorizer.

    For URI Request parameters use format: ...key1=value1&key2=value2...

    For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

    For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

    tokenKeyName String
    The key used to extract the token from the HTTP headers.
    tokenSigningPublicKeys Map<String>
    The public keys used to validate the token signature returned by your custom authentication service.

    Supporting Types

    AuthorizerStatus

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native