AWS Native

v0.43.0 published on Thursday, Dec 1, 2022 by Pulumi

getAuthorizer

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:

AuthorizerId string
RestApiId string

The identifier of the API.

AuthorizerId string
RestApiId string

The identifier of the API.

authorizerId String
restApiId String

The identifier of the API.

authorizerId string
restApiId string

The identifier of the API.

authorizer_id str
rest_api_id str

The identifier of the API.

authorizerId String
restApiId String

The identifier of the API.

getAuthorizer Result

The following output properties are available:

AuthType string

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

AuthorizerCredentials string

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.

AuthorizerId string
AuthorizerResultTtlInSeconds int

The TTL in seconds of cached authorizer results.

AuthorizerUri string

Specifies the authorizer's Uniform Resource Identifier (URI).

IdentitySource string

The identity source for which authorization is requested.

IdentityValidationExpression string

A validation expression for the incoming identity token.

Name string

The name of the authorizer.

ProviderARNs List<string>

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer.

Type string

The authorizer type.

AuthType string

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

AuthorizerCredentials string

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.

AuthorizerId string
AuthorizerResultTtlInSeconds int

The TTL in seconds of cached authorizer results.

AuthorizerUri string

Specifies the authorizer's Uniform Resource Identifier (URI).

IdentitySource string

The identity source for which authorization is requested.

IdentityValidationExpression string

A validation expression for the incoming identity token.

Name string

The name of the authorizer.

ProviderARNs []string

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer.

Type string

The authorizer type.

authType String

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

authorizerCredentials String

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.

authorizerId String
authorizerResultTtlInSeconds Integer

The TTL in seconds of cached authorizer results.

authorizerUri String

Specifies the authorizer's Uniform Resource Identifier (URI).

identitySource String

The identity source for which authorization is requested.

identityValidationExpression String

A validation expression for the incoming identity token.

name String

The name of the authorizer.

providerARNs List<String>

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer.

type String

The authorizer type.

authType string

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

authorizerCredentials string

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.

authorizerId string
authorizerResultTtlInSeconds number

The TTL in seconds of cached authorizer results.

authorizerUri string

Specifies the authorizer's Uniform Resource Identifier (URI).

identitySource string

The identity source for which authorization is requested.

identityValidationExpression string

A validation expression for the incoming identity token.

name string

The name of the authorizer.

providerARNs 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.

authorizer_credentials str

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.

authorizer_id str
authorizer_result_ttl_in_seconds int

The TTL in seconds of cached authorizer results.

authorizer_uri str

Specifies the authorizer's Uniform Resource Identifier (URI).

identity_source str

The identity source for which authorization is requested.

identity_validation_expression str

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.

authType String

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

authorizerCredentials String

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.

authorizerId String
authorizerResultTtlInSeconds Number

The TTL in seconds of cached authorizer results.

authorizerUri String

Specifies the authorizer's Uniform Resource Identifier (URI).

identitySource String

The identity source for which authorization is requested.

identityValidationExpression String

A validation expression for the incoming identity token.

name String

The name of the authorizer.

providerARNs 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
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0