AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

Authorizer

import "github.com/aws/aws-sdk-go/service/apigatewayv2"

type Authorizer struct { AuthorizerCredentialsArn *string `locationName:"authorizerCredentialsArn" type:"string"` AuthorizerId *string `locationName:"authorizerId" type:"string"` AuthorizerResultTtlInSeconds *int64 `locationName:"authorizerResultTtlInSeconds" type:"integer"` AuthorizerType *string `locationName:"authorizerType" type:"string" enum:"AuthorizerType"` AuthorizerUri *string `locationName:"authorizerUri" type:"string"` IdentitySource []*string `locationName:"identitySource" type:"list"` IdentityValidationExpression *string `locationName:"identityValidationExpression" type:"string"` Name *string `locationName:"name" type:"string" required:"true"` ProviderArns []*string `locationName:"providerArns" type:"list"` }

Represents an authorizer.

AuthorizerCredentialsArn

Type: *string

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.

AuthorizerId

Type: *string

The authorizer identifier.

AuthorizerResultTtlInSeconds

Type: *int64

The time to live (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.

AuthorizerType

Type: *string

The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.

AuthorizerUri

Type: *string

The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

IdentitySource

Type: []*string

The identity source for which authorization is requested.

For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header and a Name query string parameters are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

IdentityValidationExpression

Type: *string

The validation expression does not apply to the REQUEST authorizer.

Name

Type: *string

The name of the authorizer.

Name is a required field

ProviderArns

Type: []*string

For REQUEST authorizer, this is not defined.

Method

GoString

func (s Authorizer) GoString() string

GoString returns the string representation

SetAuthorizerCredentialsArn

func (s *Authorizer) SetAuthorizerCredentialsArn(v string) *Authorizer

SetAuthorizerCredentialsArn sets the AuthorizerCredentialsArn field's value.

SetAuthorizerId

func (s *Authorizer) SetAuthorizerId(v string) *Authorizer

SetAuthorizerId sets the AuthorizerId field's value.

SetAuthorizerResultTtlInSeconds

func (s *Authorizer) SetAuthorizerResultTtlInSeconds(v int64) *Authorizer

SetAuthorizerResultTtlInSeconds sets the AuthorizerResultTtlInSeconds field's value.

SetAuthorizerType

func (s *Authorizer) SetAuthorizerType(v string) *Authorizer

SetAuthorizerType sets the AuthorizerType field's value.

SetAuthorizerUri

func (s *Authorizer) SetAuthorizerUri(v string) *Authorizer

SetAuthorizerUri sets the AuthorizerUri field's value.

SetIdentitySource

func (s *Authorizer) SetIdentitySource(v []*string) *Authorizer

SetIdentitySource sets the IdentitySource field's value.

SetIdentityValidationExpression

func (s *Authorizer) SetIdentityValidationExpression(v string) *Authorizer

SetIdentityValidationExpression sets the IdentityValidationExpression field's value.

SetName

func (s *Authorizer) SetName(v string) *Authorizer

SetName sets the Name field's value.

SetProviderArns

func (s *Authorizer) SetProviderArns(v []*string) *Authorizer

SetProviderArns sets the ProviderArns field's value.

String

func (s Authorizer) String() string

String returns the string representation

On this page: