AWS Native

Pulumi Official
Package maintained by Pulumi
v0.19.0 published on Wednesday, Jun 8, 2022 by Pulumi

Authorizer

Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.

Create a Authorizer Resource

new Authorizer(name: string, args: AuthorizerArgs, opts?: CustomResourceOptions);
@overload
def Authorizer(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               auth_type: Optional[str] = None,
               authorizer_credentials: Optional[str] = None,
               authorizer_result_ttl_in_seconds: Optional[int] = None,
               authorizer_uri: Optional[str] = None,
               identity_source: Optional[str] = None,
               identity_validation_expression: Optional[str] = None,
               name: Optional[str] = None,
               provider_arns: Optional[Sequence[str]] = None,
               rest_api_id: Optional[str] = None,
               type: Optional[str] = None)
@overload
def Authorizer(resource_name: str,
               args: AuthorizerArgs,
               opts: Optional[ResourceOptions] = None)
func NewAuthorizer(ctx *Context, name string, args AuthorizerArgs, opts ...ResourceOption) (*Authorizer, error)
public Authorizer(string name, AuthorizerArgs args, CustomResourceOptions? opts = null)
public Authorizer(String name, AuthorizerArgs args)
public Authorizer(String name, AuthorizerArgs args, CustomResourceOptions options)
type: aws-native:apigateway:Authorizer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args AuthorizerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args AuthorizerArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args AuthorizerArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AuthorizerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args AuthorizerArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Authorizer Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Authorizer resource accepts the following input properties:

RestApiId string

The identifier of the API.

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.

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.

RestApiId string

The identifier of the API.

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.

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.

restApiId String

The identifier of the API.

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.

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.

restApiId string

The identifier of the API.

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.

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.

rest_api_id str

The identifier of the API.

type str

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

restApiId String

The identifier of the API.

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.

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.

Outputs

All input properties are implicitly available as output properties. Additionally, the Authorizer resource produces the following output properties:

AuthorizerId string
Id string

The provider-assigned unique ID for this managed resource.

AuthorizerId string
Id string

The provider-assigned unique ID for this managed resource.

authorizerId String
id String

The provider-assigned unique ID for this managed resource.

authorizerId string
id string

The provider-assigned unique ID for this managed resource.

authorizer_id str
id str

The provider-assigned unique ID for this managed resource.

authorizerId String
id String

The provider-assigned unique ID for this managed resource.

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0