AWS Native is in preview. AWS Classic is fully supported.
aws-native.apigateway.getAuthorizer
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
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_id: Optional[str] = None,
rest_api_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetAuthorizerResult
def get_authorizer_output(authorizer_id: Optional[pulumi.Input[str]] = None,
rest_api_id: 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:apigateway:getAuthorizer
arguments:
# arguments dictionary
The following arguments are supported:
- string
- Rest
Api stringId The identifier of the API.
- string
- Rest
Api stringId The identifier of the API.
- String
- rest
Api StringId The identifier of the API.
- string
- rest
Api stringId The identifier of the API.
- str
- rest_
api_ strid The identifier of the API.
- String
- rest
Api StringId The identifier of the API.
getAuthorizer Result
The following output properties are available:
- Auth
Type string Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
- string
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
- string
- int
The TTL in seconds of cached authorizer results.
- string
Specifies the authorizer's Uniform Resource Identifier (URI).
- Identity
Source string The identity source for which authorization is requested.
- Identity
Validation stringExpression A validation expression for the incoming identity token.
- Name string
The name of the authorizer.
- Provider
Arns List<string> A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer.
- Type string
The authorizer type.
- Auth
Type string Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
- string
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
- string
- int
The TTL in seconds of cached authorizer results.
- string
Specifies the authorizer's Uniform Resource Identifier (URI).
- Identity
Source string The identity source for which authorization is requested.
- Identity
Validation stringExpression A validation expression for the incoming identity token.
- Name string
The name of the authorizer.
- Provider
Arns []string A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer.
- Type string
The authorizer type.
- auth
Type String Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
- String
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
- String
- Integer
The TTL in seconds of cached authorizer results.
- String
Specifies the authorizer's Uniform Resource Identifier (URI).
- identity
Source String The identity source for which authorization is requested.
- identity
Validation StringExpression A validation expression for the incoming identity token.
- name String
The name of the authorizer.
- provider
Arns List<String> A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer.
- type String
The authorizer type.
- auth
Type string Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
- string
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
- string
- number
The TTL in seconds of cached authorizer results.
- string
Specifies the authorizer's Uniform Resource Identifier (URI).
- identity
Source string The identity source for which authorization is requested.
- identity
Validation stringExpression A validation expression for the incoming identity token.
- name string
The name of the authorizer.
- provider
Arns string[] A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer.
- type string
The authorizer type.
- auth_
type str Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
- str
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
- str
- int
The TTL in seconds of cached authorizer results.
- str
Specifies the authorizer's Uniform Resource Identifier (URI).
- identity_
source str The identity source for which authorization is requested.
- identity_
validation_ strexpression A validation expression for the incoming identity token.
- name str
The name of the authorizer.
- provider_
arns Sequence[str] A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer.
- type str
The authorizer type.
- auth
Type String Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
- String
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
- String
- Number
The TTL in seconds of cached authorizer results.
- String
Specifies the authorizer's Uniform Resource Identifier (URI).
- identity
Source String The identity source for which authorization is requested.
- identity
Validation StringExpression A validation expression for the incoming identity token.
- name String
The name of the authorizer.
- provider
Arns List<String> A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer.
- type String
The authorizer type.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.