HttpApiAuth

권한 부여를 구성하여 Amazon API Gateway HTTP API에 대한 액세스를 제어합니다.

HTTP API에 대한 액세스 구성에 대한 자세한 내용은 API Gateway 개발자 안내서의 API Gateway의 HTTP API에 대한 액세스 제어 및 관리 섹션을 참조하세요.

구문

AWS Serverless Application Model (AWS SAM) 템플릿에서 이 엔티티를 선언하려면 다음 구문을 사용하십시오.

YAML

  Authorizers: OAuth2Authorizer | LambdaAuthorizer
  DefaultAuthorizer: String
  EnableIamAuthorizer: Boolean

속성

Authorizers

API Gateway API에 대한 액세스를 제어하는 데 사용되는 권한 부여자.

유형: OAuth2 권한 부여자 | LambdaAuthorizer

필수 항목 여부: 아니요

기본값: 없음

AWS CloudFormation 호환성: 이 속성은 AWS SAM 고유하며 이에 상응하는 속성이 없습니다. AWS CloudFormation

추가 참고 사항: OpenAPI 정의에 권한 부여자를 AWS SAM 추가합니다.

DefaultAuthorizer

API Gateway API에 대한 API 호출을 승인하는 데 사용할 기본 권한 부여자를 지정합니다. EnableIamAuthorizer가 true로 설정된 경우 AWS_IAM을 기본 권한 부여자로 지정할 수 있습니다. 그렇지 않은 경우 Authorizers에서 정의한 권한 부여자를 지정합니다.

타입: 문자열

필수 항목 여부: 아니요

기본값: 없음

AWS CloudFormation 호환성: 이 속성은 AWS SAM 고유하며 이에 상응하는 속성이 없습니다. AWS CloudFormation

EnableIamAuthorizer

API 경로에 IAM 인증을 사용할지 여부를 지정합니다.

유형: 부울

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS SAM 고유하며 AWS CloudFormation 이에 상응하는 속성이 없습니다.

예

OAuth 2.0 권한 부여자

OAuth 2.0 권한 부여자 예시

YAML

Auth:
  Authorizers:
    OAuth2Authorizer:
      AuthorizationScopes:
        - scope1
        - scope2
      JwtConfiguration:
        issuer: "https://www.example.com/v1/connect/oauth2"
        audience:
          - MyApi
      IdentitySource: "$request.querystring.param"
  DefaultAuthorizer: OAuth2Authorizer

IAM 권한 부여자

IAM 권한 부여자 예시

YAML

Auth:
  EnableIamAuthorizer: true
  DefaultAuthorizer: AWS_IAM