We recommend new projects start with resources from the AWS provider.
aws-native.iot.getAuthorizer
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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:
- string
- The authorizer name.
- string
- The authorizer name.
- String
- The authorizer name.
- string
- The authorizer name.
- str
- The authorizer name.
- String
- The authorizer name.
getAuthorizer Result
The following output properties are available:
- Arn string
- The Amazon Resource Name (ARN) of the authorizer.
- string
- The authorizer's Lambda function ARN.
- Enable
Caching boolFor Http - 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 inrefreshAfterInSeconds
. This value doesn't affect authorization of clients that use MQTT connections. - Status
Pulumi.
Aws Native. Io T. Authorizer Status The status of the authorizer.
Valid values:
ACTIVE
|INACTIVE
- List<Pulumi.
Aws Native. 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..."
- Token
Key stringName - The key used to extract the token from the HTTP headers.
- Token
Signing Dictionary<string, string>Public Keys - 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.
- string
- The authorizer's Lambda function ARN.
- Enable
Caching boolFor Http - 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 inrefreshAfterInSeconds
. This value doesn't affect authorization of clients that use MQTT connections. - Status
Authorizer
Status The status of the authorizer.
Valid values:
ACTIVE
|INACTIVE
- 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 stringName - The key used to extract the token from the HTTP headers.
- Token
Signing map[string]stringPublic Keys - 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.
- String
- The authorizer's Lambda function ARN.
- enable
Caching BooleanFor Http - 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 inrefreshAfterInSeconds
. This value doesn't affect authorization of clients that use MQTT connections. - status
Authorizer
Status The status of the authorizer.
Valid values:
ACTIVE
|INACTIVE
- 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..."
- token
Key StringName - The key used to extract the token from the HTTP headers.
- token
Signing Map<String,String>Public Keys - 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.
- string
- The authorizer's Lambda function ARN.
- enable
Caching booleanFor Http - 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 inrefreshAfterInSeconds
. This value doesn't affect authorization of clients that use MQTT connections. - status
Authorizer
Status The status of the authorizer.
Valid values:
ACTIVE
|INACTIVE
- 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 stringName - The key used to extract the token from the HTTP headers.
- token
Signing {[key: string]: string}Public Keys - 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.
- str
- The authorizer's Lambda function ARN.
- enable_
caching_ boolfor_ http - 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 inrefreshAfterInSeconds
. This value doesn't affect authorization of clients that use MQTT connections. - status
Authorizer
Status The status of the authorizer.
Valid values:
ACTIVE
|INACTIVE
- 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_ strname - The key used to extract the token from the HTTP headers.
- token_
signing_ Mapping[str, str]public_ keys - 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.
- String
- The authorizer's Lambda function ARN.
- enable
Caching BooleanFor Http - 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 inrefreshAfterInSeconds
. This value doesn't affect authorization of clients that use MQTT connections. - status "ACTIVE" | "INACTIVE"
The status of the authorizer.
Valid values:
ACTIVE
|INACTIVE
- 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..."
- token
Key StringName - The key used to extract the token from the HTTP headers.
- token
Signing Map<String>Public Keys - The public keys used to validate the token signature returned by your custom authentication service.
Supporting Types
AuthorizerStatus
Tag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.