Create Authorizer
apigateway_create_authorizer | R Documentation |
Adds a new Authorizer resource to an existing RestApi resource¶
Description¶
Adds a new Authorizer resource to an existing RestApi resource.
Usage¶
apigateway_create_authorizer(restApiId, name, type, providerARNs,
authType, authorizerUri, authorizerCredentials, identitySource,
identityValidationExpression, authorizerResultTtlInSeconds)
Arguments¶
restApiId |
[required] The string identifier of the associated RestApi. |
name |
[required] The name of the authorizer. |
type |
[required] The authorizer type. Valid values are
|
providerARNs |
A list of the Amazon Cognito user pool ARNs for the
|
authType |
Optional customer-defined field, used in OpenAPI imports and exports without functional impact. |
authorizerUri |
Specifies the authorizer's Uniform Resource Identifier (URI). For
|
authorizerCredentials |
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. |
identitySource |
The identity source for which authorization is requested. For a
|
identityValidationExpression |
A validation expression for the incoming identity token. For
|
authorizerResultTtlInSeconds |
The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour. |
Value¶
A list with the following syntax:
list(
id = "string",
name = "string",
type = "TOKEN"|"REQUEST"|"COGNITO_USER_POOLS",
providerARNs = list(
"string"
),
authType = "string",
authorizerUri = "string",
authorizerCredentials = "string",
identitySource = "string",
identityValidationExpression = "string",
authorizerResultTtlInSeconds = 123
)
Request syntax¶
svc$create_authorizer(
restApiId = "string",
name = "string",
type = "TOKEN"|"REQUEST"|"COGNITO_USER_POOLS",
providerARNs = list(
"string"
),
authType = "string",
authorizerUri = "string",
authorizerCredentials = "string",
identitySource = "string",
identityValidationExpression = "string",
authorizerResultTtlInSeconds = 123
)