@Stability(value=Stable) public static final class CfnAuthorizerProps.Builder extends Object implements software.amazon.jsii.Builder<CfnAuthorizerProps>
CfnAuthorizerProps| Constructor and Description |
|---|
Builder() |
@Stability(value=Stable) public CfnAuthorizerProps.Builder name(String name)
CfnAuthorizerProps.getName()name - The name of the authorizer. This parameter is required.this@Stability(value=Stable) public CfnAuthorizerProps.Builder restApiId(String restApiId)
CfnAuthorizerProps.getRestApiId()restApiId - The ID of the `RestApi` resource that API Gateway creates the authorizer in. This parameter is required.this@Stability(value=Stable) public CfnAuthorizerProps.Builder type(String type)
CfnAuthorizerProps.getType()type - The type of authorizer. Valid values include:. This parameter is required.
TOKEN : A custom authorizer that uses a Lambda function.COGNITO_USER_POOLS : An authorizer that uses Amazon Cognito user pools.REQUEST : An authorizer that uses a Lambda function using incoming request parameters.this@Stability(value=Stable) public CfnAuthorizerProps.Builder authorizerCredentials(String authorizerCredentials)
CfnAuthorizerProps.getAuthorizerCredentials()authorizerCredentials - The credentials that are required for the authorizer.
To specify an IAM role that API Gateway assumes, specify the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.this@Stability(value=Stable) public CfnAuthorizerProps.Builder authorizerResultTtlInSeconds(Number authorizerResultTtlInSeconds)
CfnAuthorizerProps.getAuthorizerResultTtlInSeconds()authorizerResultTtlInSeconds - The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches authorizer results.
If you specify a value greater than 0, API Gateway caches the authorizer responses. By default, API Gateway sets this property to 300. The maximum value is 3600, or 1 hour.this@Stability(value=Stable) public CfnAuthorizerProps.Builder authorizerUri(String authorizerUri)
CfnAuthorizerProps.getAuthorizerUri()authorizerUri - The authorizer's Uniform Resource Identifier (URI).
If you specify TOKEN for the authorizer's Type property, specify a Lambda function URI that has the form arn:aws:apigateway: *region* :lambda:path/ *path* . The path usually has the form /2015-03-31/functions/ LambdaFunctionARN /invocations.this@Stability(value=Stable) public CfnAuthorizerProps.Builder authType(String authType)
CfnAuthorizerProps.getAuthType()authType - An optional customer-defined field that's used in OpenApi imports and exports without functional impact.this@Stability(value=Stable) public CfnAuthorizerProps.Builder identitySource(String identitySource)
CfnAuthorizerProps.getIdentitySource()identitySource - The source of the identity in an incoming request.
If you specify TOKEN or COGNITO_USER_POOLS for the Type property, this property is required. Specify a header mapping expression using the form method.request.header. *name* , where name is the name of a custom authorization header that clients submit as part of their requests.
If you specify REQUEST for the Type property, this property is required when authorization caching is enabled. Specify a comma-separated string of one or more mapping expressions of the specified request parameter using the form method.request.parameter. *name* . For supported parameter types, see Configure Lambda Authorizer Using the API Gateway Console in the API Gateway Developer Guide .
this@Stability(value=Stable) public CfnAuthorizerProps.Builder identityValidationExpression(String identityValidationExpression)
CfnAuthorizerProps.getIdentityValidationExpression()identityValidationExpression - A validation expression for the incoming identity.
If you specify TOKEN for the authorizer's Type property, specify a regular expression. API Gateway uses the expression to attempt to match the incoming client token, and proceeds if the token matches. If the token doesn't match, API Gateway responds with a 401 (unauthorized request) error code.this@Stability(value=Stable) public CfnAuthorizerProps.Builder providerArns(List<String> providerArns)
CfnAuthorizerProps.getProviderArns()providerArns - A list of the Amazon Cognito user pool Amazon Resource Names (ARNs) to associate with this authorizer.
Required if you specify COGNITO_USER_POOLS as the authorizer Type . For more information, see Use Amazon Cognito User Pools in the API Gateway Developer Guide .this@Stability(value=Stable) public CfnAuthorizerProps build()
build in interface software.amazon.jsii.Builder<CfnAuthorizerProps>CfnAuthorizerPropsNullPointerException - if any required attribute was not providedCopyright © 2022. All rights reserved.