AWS Native is in preview. AWS Classic is fully supported.
aws-native.apigateway.Authorizer
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.
Create 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:
- Rest
Api stringId The identifier of the API.
- 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.
- 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.
- Rest
Api stringId The identifier of the API.
- 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.
- 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.
- rest
Api StringId The identifier of the API.
- 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.
- 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.
- rest
Api stringId The identifier of the API.
- 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.
- 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.
- rest_
api_ strid 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.
- str
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
- 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.
- rest
Api StringId The identifier of the API.
- 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.
- 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the Authorizer resource produces the following output properties:
- string
- Id string
The provider-assigned unique ID for this managed resource.
- string
- Id string
The provider-assigned unique ID for this managed resource.
- String
- id String
The provider-assigned unique ID for this managed resource.
- string
- id string
The provider-assigned unique ID for this managed resource.
- str
- id str
The provider-assigned unique ID for this managed resource.
- String
- id String
The provider-assigned unique ID for this managed resource.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.