public final class AuthorizerDefinition extends java.lang.Object implements ToNode, ToSmithyBuilder<AuthorizerDefinition>
AuthorizersTrait
Modifier and Type | Class and Description |
---|---|
static class |
AuthorizerDefinition.Builder
Builder used to create an
AuthorizerDefinition . |
Modifier and Type | Method and Description |
---|---|
static AuthorizerDefinition.Builder |
builder()
Creates a builder for an Authorizer.
|
boolean |
equals(java.lang.Object o) |
java.util.Optional<java.lang.String> |
getCredentials()
Gets the Credentials required for invoking the authorizer, if any, in
the form of an ARN of an IAM execution role.
|
java.util.Optional<java.lang.String> |
getCustomAuthType()
Gets the customAuthType of the authorizer.
|
java.util.Optional<java.lang.String> |
getIdentitySource()
Gets the comma-separated list of mapping expressions of the request
parameters as the identity source.
|
java.util.Optional<java.lang.String> |
getIdentityValidationExpression()
Gets the regular expression for validating the token as the incoming
identity.
|
java.util.Optional<java.lang.Integer> |
getResultTtlInSeconds()
Gets the number of seconds during which the resulting IAM policy
is cached.
|
ShapeId |
getScheme()
Gets the Smithy scheme used as the client authentication type.
|
java.util.Optional<java.lang.String> |
getType()
Gets the type of the authorizer.
|
java.util.Optional<java.lang.String> |
getUri()
Gets the Uniform Resource Identifier (URI) of the authorizer
Lambda function.
|
int |
hashCode() |
AuthorizerDefinition.Builder |
toBuilder()
Take this object and create a builder that contains all of the
current property values of this object.
|
Node |
toNode()
Converts a value to a
Node . |
public static AuthorizerDefinition.Builder builder()
public ShapeId getScheme()
public java.util.Optional<java.lang.String> getType()
If specifying information beyond the scheme, this value is required. The value must be "token", for an authorizer with the caller identity embedded in an authorization token, or "request", for an authorizer with the caller identity contained in request parameters.
public java.util.Optional<java.lang.String> getUri()
public java.util.Optional<java.lang.String> getCustomAuthType()
This value is not used directly by APIGateway but will be used for
OpenAPI exports. This will default to "awsSigV4" if your scheme is
aws.auth#sigv4
.
public java.util.Optional<java.lang.String> getCredentials()
For example, "arn:aws:iam::account-id:IAM_role".
public java.util.Optional<java.lang.String> getIdentitySource()
This property is only applicable for the authorizer of the "request" type only.
public java.util.Optional<java.lang.String> getIdentityValidationExpression()
"^x-[a-z]+"
.public java.util.Optional<java.lang.Integer> getResultTtlInSeconds()
public AuthorizerDefinition.Builder toBuilder()
ToSmithyBuilder
toBuilder
in interface ToSmithyBuilder<AuthorizerDefinition>
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object