Bicep 리소스 정의
appSyncGraphqlApis 리소스 종류는 다음을 대상으로 하는 작업으로 배포할 수 있습니다.
각 API 버전에서 변경된 속성 목록은 변경 로그참조하세요.
Microsoft.AwsConnector/appSyncGraphqlApis 리소스를 만들려면 템플릿에 다음 Bicep을 추가합니다.
resource symbolicname 'Microsoft.AwsConnector/appSyncGraphqlApis@2024-12-01' = {
location: 'string'
name: 'string'
properties: {
arn: 'string'
awsAccountId: 'string'
awsProperties: {
additionalAuthenticationProviders: [
{
authenticationType: {
value: 'string'
}
lambdaAuthorizerConfig: {
authorizerResultTtlInSeconds: int
authorizerUri: 'string'
identityValidationExpression: 'string'
}
openIDConnectConfig: {
authTTL: int
clientId: 'string'
iatTTL: int
issuer: 'string'
}
userPoolConfig: {
appIdClientRegex: 'string'
awsRegion: 'string'
userPoolId: 'string'
}
}
]
apiId: 'string'
apiType: {
value: 'string'
}
arn: 'string'
authenticationType: {
value: 'string'
}
dns: {
{customized property}: 'string'
}
enhancedMetricsConfig: {
dataSourceLevelMetricsBehavior: {
value: 'string'
}
operationLevelMetricsConfig: {
value: 'string'
}
resolverLevelMetricsBehavior: {
value: 'string'
}
}
introspectionConfig: {
value: 'string'
}
lambdaAuthorizerConfig: {
authorizerResultTtlInSeconds: int
authorizerUri: 'string'
identityValidationExpression: 'string'
}
logConfig: {
cloudWatchLogsRoleArn: 'string'
excludeVerboseContent: bool
fieldLogLevel: {
value: 'string'
}
}
mergedApiExecutionRoleArn: 'string'
name: 'string'
openIDConnectConfig: {
authTTL: int
clientId: 'string'
iatTTL: int
issuer: 'string'
}
owner: 'string'
ownerContact: 'string'
queryDepthLimit: int
resolverCountLimit: int
tags: {
{customized property}: 'string'
}
uris: {
{customized property}: 'string'
}
userPoolConfig: {
appIdClientRegex: 'string'
awsRegion: 'string'
defaultAction: {
value: 'string'
}
userPoolId: 'string'
}
visibility: {
value: 'string'
}
wafWebAclArn: 'string'
xrayEnabled: bool
}
awsRegion: 'string'
awsSourceSchema: 'string'
awsTags: {
{customized property}: 'string'
}
publicCloudConnectorsResourceId: 'string'
publicCloudResourceName: 'string'
}
tags: {
{customized property}: 'string'
}
}
속성 값
Microsoft.AwsConnector/appSyncGraphqlApis
| 이름 |
묘사 |
값 |
| 위치 |
리소스가 있는 지리적 위치 |
string(필수) |
| 이름 |
리소스 이름 |
문자열
제약 조건: 패턴 = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#])(필수) |
| 속성 |
이 리소스에 대한 리소스별 속성입니다. |
AppSyncGraphqlApiProperties |
| 태그 |
리소스 태그 |
태그 이름 및 값의 사전입니다. 템플릿 태그를 참조하세요. |
추가 인증제공자
| 이름 |
묘사 |
값 |
| 인증유형 |
<p>인증 유형: API 키, IAM(ID 및 액세스 관리), OIDC(OpenID Connect), Amazon Cognito 사용자 풀 또는 람다입니다. /p<> |
AuthenticationTypeEnumValue |
| 람다AuthorizerConfig |
<p>람다 함수 권한 부여에 대한 구성입니다. /p<> |
람다AuthorizerConfig |
| openIDConnectConfig |
<p>OIDC 구성입니다. /p<> |
OpenIDConnectConfig |
| userPoolConfig |
<p>Amazon Cognito 사용자 풀 구성입니다. /p<> |
CognitoUserPoolConfig |
AppSyncGraphqlApi속성
| 이름 |
묘사 |
값 |
| 아른(ARN) |
ARN(Amazon Resource Name) |
문자열 |
| awsAccountId 님 |
AWS 계정 ID |
문자열 |
| aws속성 |
AWS 속성 |
AwsAppSyncGraphqlApi속성 |
| aws지역 |
AWS 지역 |
문자열 |
| awsSource스키마 |
AWS 원본 스키마 |
문자열 |
| aws태그 |
AWS 태그 |
AppSyncGraphqlApiPropertiesAws태그 |
| publicCloudConnectorsResourceId |
퍼블릭 클라우드 커넥터 리소스 ID |
문자열 |
| publicCloudResourceName |
퍼블릭 클라우드 리소스 이름 |
문자열 |
AuthenticationTypeEnumValue
| 이름 |
묘사 |
값 |
| 값 |
속성 값 |
'AMAZON_COGNITO_USER_POOLS' 'API_KEY' 'AWS_IAM' 'AWS_LAMBDA' 'OPENID_CONNECT' |
AwsAppSyncGraphqlApi속성
| 이름 |
묘사 |
값 |
| additionalAuthentication공급자 |
<p>GraphqlApi</code> API를<>코드에 대한 추가 인증 공급자 목록입니다.</p> |
추가 인증 제공자[] |
| apiId를 입력합니다. |
<p>API ID입니다.</p> |
문자열 |
| api유형 |
<p>GraphQL API가 표준 API(<코드>GRAPHQL</code>) 또는 병합된 API(MERGED</code><>코드)인지를 나타내는 값입니다.</p> |
GraphQLApiTypeEnumValue |
| 아른(ARN) |
<p>ARN(Amazon Resource Name)입니다. /p<> |
문자열 |
| 인증유형 |
<p>인증 유형입니다. /p<> |
AuthenticationTypeEnumValue |
| dns(dns) |
<p>API에 대한 DNS 레코드입니다. /p<> |
awsAppSyncGraphqlApiPropertiesDns |
| enhancedMetricsConfig |
<p><코드>enhancedMetricsConfig</code> 개체입니다.</p> |
EnhancedMetricsConfig |
| 인트로스펙션Config |
<p>GraphQL API의 값을 설정하여 (<코드>ENABLED</code>) 또는 비활성화(<코드>DISABLED</code>) 내성 검사를 사용하도록 설정합니다. 값이 제공되지 않으면 기본적으로 introspection 구성이 enablED</code><>코드로 설정됩니다. 이 필드는 이 필드를 사용하지 않도록 설정된 동안 작업에서 내성 기능을 사용하려고 하면 오류가 발생합니다.</p><p>>대한 자세한 내용은 href='https://graphql.org/learn/introspection/'>GraphQL 성찰</a><참조하세요.>/p |
GraphQLApiIntrospectionConfigEnumValue |
| 람다AuthorizerConfig |
<p>람다 함수 권한 부여에 대한 구성입니다. /p<> |
람다AuthorizerConfig |
| 로그 구성 |
<p>Amazon CloudWatch 로그 구성입니다. /p<> |
LogConfig |
| mergedApiExecutionRoleArn |
<p>병합된 API에 대한 ID 및 액세스 관리 서비스 역할 ARN입니다. AppSync 서비스는 병합된 API를 대신하여 이 역할을 사용하여 런타임에 원본 API에 대한 액세스의 유효성을 검사하고 <코드>AUTO_MERGE</code> 소스 API 변경 내용으로 병합된 API 엔드포인트를 자동으로 업데이트하라는 메시지를 표시합니다.</p> |
문자열 |
| 이름 |
<p>API 이름입니다. /p<> |
문자열 |
| openIDConnectConfig |
<p>OpenID Connect 구성입니다. /p<> |
OpenIDConnectConfig |
| 소유자 |
<p>GraphQL API의 계정 소유자입니다. /p<> |
문자열 |
| 소유자연락처 |
<p>API 리소스에 대한 소유자 연락처 정보입니다.</p><p>이 필드는 길이가 0~256자인 문자열 입력을 허용합니다.</p> |
문자열 |
| 쿼리 깊이 제한 |
<p>쿼리가 단일 요청에서 가질 수 있는 최대 수준입니다. 깊이는 쿼리 본문에 허용되는 중첩된 수준의 양을 나타냅니다. 기본값은 <코드>0</code>(또는 지정되지 않음)이며 이는 깊이 제한이 없음을 나타냅니다. 제한을 설정하는 경우 <코드>1</code> 코드와 <코드>75</code> 중첩된 수준 사이일 수 있습니다. 이 필드는 작업이 범위를 벗어나는 경우 제한 오류를 생성합니다.</p><p>필드는 여전히 nullable 또는 nullable이 아닌 필드로 설정할 수 있습니다. null을 허용하지 않는 필드에 오류가 발생하면 사용 가능한 첫 번째 null 허용 필드로 오류가 위쪽으로 throw됩니다.</p> |
정수 (int) |
| 리졸버CountLimit |
<p>단일 요청에서 호출할 수 있는 최대 확인자 수입니다. 기본값은 <코드>0</code>(또는 지정되지 않음)이며, <코드>10000</code>로 제한을 설정합니다. 지정된 경우 제한 값은 <코드>1</code> 및 <코드>10000</code>사이일 수 있습니다. 이 필드는 작업이 범위를 벗어나는 경우 제한 오류를 생성합니다.</p> |
정수 (int) |
| 태그 |
<p>태그입니다. /p<> |
awsAppSyncGraphqlApiProperties태그 |
| URI |
p<URI를 >. /p<> |
awsAppSyncGraphqlApiPropertiesUris |
| userPoolConfig |
<p>Amazon Cognito 사용자 풀 구성입니다. /p<> |
UserPoolConfig |
| 시정 |
<p>GraphQL API의 값을 public(<코드>GLOBAL</code>) 또는 private(private(<코드>PRIVATE</code>)으로 설정합니다. 값이 제공되지 않으면 표시 유형이 기본적으로 GLOBAL</code><>코드로 설정됩니다. API를 만든 후에는 이 값을 변경할 수 없습니다.</p> |
GraphQLApiVisibilityEnumValue |
| wafWebAclArn |
<p>GraphqlApi</code><이 >코드와 연결된 WAF ACL(액세스 제어 목록)의 ARN(있는 경우)입니다.</p> |
문자열 |
| 엑스레이 활성화 |
<p>GraphqlApi</code><이 >코드에 대해 X-Ray 추적을 사용할지 여부를 나타내는 플래그입니다.</p> |
bool |
awsAppSyncGraphqlApiPropertiesDns
AwsAppSyncGraphqlApiPropertiesUris
CognitoUserPoolConfig
| 이름 |
묘사 |
값 |
| appIdClientRegex |
<p>들어오는 Amazon Cognito 사용자 풀 앱 클라이언트 ID의 유효성을 검사하기 위한 정규식입니다. 이 값을 설정하지 않으면 필터링이 적용되지 않습니다.</p> |
문자열 |
| aws지역 |
<p>사용자 풀이 만들어진 Amazon Web Services 지역입니다. /p<> |
문자열 |
| userPoolId |
<p>사용자 풀 ID입니다.</p> |
문자열 |
DataSourceLevelMetricsBehaviorEnumValue
| 이름 |
묘사 |
값 |
| 값 |
속성 값 |
'FULL_REQUEST_DATA_SOURCE_METRICS' 'PER_DATA_SOURCE_METRICS' |
DefaultActionEnumValue
EnhancedMetricsConfig
| 이름 |
묘사 |
값 |
| dataSourceLevelMetrics동작 |
<p>데이터 원본 메트릭을 CloudWatch에 내보내는 방법을 제어합니다. 데이터 원본 메트릭에는</p><ul><li><p>요청: 요청 중에 발생한 호출 수입니다.</p></li><li><p>대기 시간: 데이터 원본 호출을 완료하는 시간입니다.</p></li><li><p>오류: 데이터 원본 호출 중에 발생한 오류 수입니다.</p></li></ul><p>이러한 메트릭은 데이터 원본당 또는 요청의 모든 데이터 원본에 대해 CloudWatch로 내보낼 수 있습니다. 메트릭은 API ID 및 데이터 원본 이름으로 기록됩니다.
<코드>dataSourceLevelMetricsBehavior</code></p><ul><li><p><코드>FULL_REQUEST_DATA_SOURCE_METRICS</code>: 요청의 모든 데이터 원본에 대한 메트릭 데이터를 기록하고 내보낸다.</p></li><li><p><코드>PER_DATA_SOURCE_METRICS</code>: <코드>metricsConfig</code> 값이 <코드>enablED</code>설정된 데이터 원본에 대한 메트릭 데이터를 기록하고 내보낸다.</p></li></ul> |
DataSourceLevelMetricsBehaviorEnumValue |
| operationLevelMetricsConfig |
<p> 작업 메트릭을 CloudWatch에 내보내는 방법을 제어합니다. 작업 메트릭에는</p><ul><li><p>요청: 지정된 GraphQL 작업이 호출된 횟수입니다.</p></li><li><p>GraphQL 오류: 지정된 GraphQL 작업 중에 발생한 GraphQL 오류 수입니다.</p></li></ul><p>메트릭은 API ID 및 작업 이름으로 기록됩니다. 값이 ENABLED</code><>코드 또는 <코드>DISABLED</code>>설정할 수 있습니다.>/p |
operationLevelMetricsConfigEnumValue |
| resolverLevelMetrics동작 |
<p>확인자 메트릭을 CloudWatch에 내보내는 방법을 제어합니다. 해결 프로그램 메트릭은 다음과 같습니다.</p><ul><li><p>GraphQL 오류: 발생한 GraphQL 오류 수입니다.</p></li><li><p>요청: 요청 중에 발생한 호출 수입니다.
</p></li><li><p>대기 시간: 해결 프로그램 호출을 완료하는 시간입니다.</p></li><li><p>Cache hits: 요청 중 캐시 적중 횟수입니다.</p></li><li><p>Cache 누락: 요청 중 캐시 누락 수입니다.</p></li></ul><p>이러한 메트릭은 확인자당 CloudWatch 또는 요청의 모든 확인자에 대해 내보낼 수 있습니다. 메트릭은 API ID 및 확인자 이름으로 기록됩니다.
<코드>resolverLevelMetricsBehavior</code></p><ul><li><p><코드>FULL_REQUEST_RESOLVER_METRICS</code>: 요청의 모든 확인자에 대한 메트릭 데이터를 기록하고 내보낸다.</p></li><li><p><코드>PER_RESOLVER_METRICS</code>: <코드>metricsConfig</code> 값이 enablED</code><코드 >로 설정된 확인자에 대한 메트릭 데이터를 기록하고 내보낸다.</p></li></ul> |
ResolverLevelMetricsBehaviorEnumValue |
FieldLogLevelEnumValue
| 이름 |
묘사 |
값 |
| 값 |
속성 값 |
'모두' '오류' '없음' |
GraphQLApiIntrospectionConfigEnumValue
| 이름 |
묘사 |
값 |
| 값 |
속성 값 |
'사용 안 함' '사용' |
GraphQLApiTypeEnumValue
| 이름 |
묘사 |
값 |
| 값 |
속성 값 |
'그래프QL' '병합됨' |
GraphQLApiVisibilityEnumValue
| 이름 |
묘사 |
값 |
| 값 |
속성 값 |
'글로벌' '비공개' |
람다AuthorizerConfig
| 이름 |
묘사 |
값 |
| authorizerResultTtlInSeconds |
<p>응답을 캐시해야 하는 시간(초)입니다. 기본값은 캐싱을 사용하지 않도록 설정하는 0초입니다.
<코드>authorizerResultTtlInSeconds</code>값을 지정하지 않으면 기본값이 사용됩니다. 최대값은 1시간(3600초)입니다. 람다 함수는 응답에서 ttlOverride</code> 키를<>코드를 반환하여 이를 재정의할 수 있습니다.</p> |
정수 (int) |
| authorizerUri |
<p>권한 부여를 위해 호출할 람다 함수의 ARN(Amazon Resource Name)입니다. 표준 람다 ARN, 버전 ARN(<코드>.../v3</code>) 또는 별칭 ARN일 수 있습니다.
</p><p><b>참고</b>: 이 람다 함수에는 다음 리소스 기반 정책이 할당되어 있어야 합니다. 콘솔에서 람다 권한 부여자를 구성할 때 이 작업이 수행됩니다. CLI(명령줄 인터페이스)를 사용하려면 다음을 실행합니다.</p><p><코드>aws lambda 추가 권한 --function-name 'arn:aws:lambda:us-east-2:111122223333:function:my-function' --statement-id 'appsync' --principal appsync.amazonaws.com --action lambda:InvokeFunction</code></p> |
문자열 |
| 신원 확인 표현식 |
<p>람다 함수가 호출되기 전에 토큰 유효성 검사를 위한 정규식입니다. /p<> |
문자열 |
로그 구성
| 이름 |
묘사 |
값 |
| cloudWatchLogs역할Arn |
<p>AppSync에서 계정의 CloudWatch 로그에 게시하는 것으로 가정하는 서비스 역할입니다. /p<> |
문자열 |
| excludeVerboseContent 제외 |
<p>로깅 수준에 관계없이 헤더, 컨텍스트 및 평가된 매핑 템플릿과 같은 정보가 포함된 섹션을 제외하려면 TRUE로 설정합니다. /p<> |
bool |
| 필드 로그 레벨 |
<p>필드 로깅 수준입니다. 값은 NONE, ERROR 또는 ALL일 수 있습니다.</p><ul><li><p><b>NONE</b>: 필드 수준 로그가 캡처되지 않습니다.</p></li><li><p><b>ERROR</b>:</p><ul><li><p>서버 응답의 오류 섹션입니다. /p<>/li<>li<>p<필드 수준 오류를>.</p></li><li><p>오류 필드에 대해 확인된 생성된 요청/응답 함수입니다.</p></li></ul></li><li><p><b>ALL</b>:</p><ul><li><p>필드 수준 추적 정보입니다.</p></li><li><p>각 필드에 대해 확인된 생성된 요청/응답 함수입니다.</p></li></ul></li></ul> |
fieldLogLevelEnumValue |
OpenIDConnectConfig
| 이름 |
묘사 |
값 |
| 인증 TTL |
<p>인증된 후 토큰이 유효한 시간(밀리초)입니다. /p<> |
정수 (int) |
| 클라이언트 ID |
<p>OpenID ID 공급자에서 신뢰 당사자의 클라이언트 식별자입니다. 이 식별자는 일반적으로 신뢰 당사자가 OpenID ID 공급자에 등록될 때 가져옵니다. AppSync가 한 번에 여러 클라이언트 식별자에 대해 유효성을 검사할 수 있도록 정규식을 지정할 수 있습니다.</p> |
문자열 |
| iatTTL |
<p>토큰이 사용자에게 발급된 후 유효한 시간(밀리초)입니다. /p<> |
정수 (int) |
| 발급자 |
<p>OIDC 구성에 대한 발급자입니다. 검색에서 반환된 발급자는 ID 토큰의</code><>코드 값과 정확히 일치해야 합니다.</p> |
문자열 |
OperationLevelMetricsConfigEnumValue
| 이름 |
묘사 |
값 |
| 값 |
속성 값 |
'사용 안 함' '사용' |
ResolverLevelMetricsBehaviorEnumValue
| 이름 |
묘사 |
값 |
| 값 |
속성 값 |
'FULL_REQUEST_RESOLVER_METRICS' 'PER_RESOLVER_METRICS' |
사용자 풀 구성
| 이름 |
묘사 |
값 |
| appIdClientRegex |
<p>들어오는 Amazon Cognito 사용자 풀 앱 클라이언트 ID의 유효성을 검사하기 위한 정규식입니다. 이 값을 설정하지 않으면 필터링이 적용되지 않습니다.</p> |
문자열 |
| aws지역 |
<p>사용자 풀이 만들어진 Amazon Web Services 지역입니다. /p<> |
문자열 |
| defaultAction |
<p>Amazon Cognito 사용자 풀 인증을 사용하는 요청이 Amazon Cognito 사용자 풀 구성과 일치하지 않을 때 GraphQL API에서 수행하려는 작업입니다. /p<> |
DefaultActionEnumValue |
| userPoolId |
<p>사용자 풀 ID입니다.</p> |
문자열 |
ARM 템플릿 리소스 정의
appSyncGraphqlApis 리소스 종류는 다음을 대상으로 하는 작업으로 배포할 수 있습니다.
각 API 버전에서 변경된 속성 목록은 변경 로그참조하세요.
Microsoft.AwsConnector/appSyncGraphqlApis 리소스를 만들려면 템플릿에 다음 JSON을 추가합니다.
{
"type": "Microsoft.AwsConnector/appSyncGraphqlApis",
"apiVersion": "2024-12-01",
"name": "string",
"location": "string",
"properties": {
"arn": "string",
"awsAccountId": "string",
"awsProperties": {
"additionalAuthenticationProviders": [
{
"authenticationType": {
"value": "string"
},
"lambdaAuthorizerConfig": {
"authorizerResultTtlInSeconds": "int",
"authorizerUri": "string",
"identityValidationExpression": "string"
},
"openIDConnectConfig": {
"authTTL": "int",
"clientId": "string",
"iatTTL": "int",
"issuer": "string"
},
"userPoolConfig": {
"appIdClientRegex": "string",
"awsRegion": "string",
"userPoolId": "string"
}
}
],
"apiId": "string",
"apiType": {
"value": "string"
},
"arn": "string",
"authenticationType": {
"value": "string"
},
"dns": {
"{customized property}": "string"
},
"enhancedMetricsConfig": {
"dataSourceLevelMetricsBehavior": {
"value": "string"
},
"operationLevelMetricsConfig": {
"value": "string"
},
"resolverLevelMetricsBehavior": {
"value": "string"
}
},
"introspectionConfig": {
"value": "string"
},
"lambdaAuthorizerConfig": {
"authorizerResultTtlInSeconds": "int",
"authorizerUri": "string",
"identityValidationExpression": "string"
},
"logConfig": {
"cloudWatchLogsRoleArn": "string",
"excludeVerboseContent": "bool",
"fieldLogLevel": {
"value": "string"
}
},
"mergedApiExecutionRoleArn": "string",
"name": "string",
"openIDConnectConfig": {
"authTTL": "int",
"clientId": "string",
"iatTTL": "int",
"issuer": "string"
},
"owner": "string",
"ownerContact": "string",
"queryDepthLimit": "int",
"resolverCountLimit": "int",
"tags": {
"{customized property}": "string"
},
"uris": {
"{customized property}": "string"
},
"userPoolConfig": {
"appIdClientRegex": "string",
"awsRegion": "string",
"defaultAction": {
"value": "string"
},
"userPoolId": "string"
},
"visibility": {
"value": "string"
},
"wafWebAclArn": "string",
"xrayEnabled": "bool"
},
"awsRegion": "string",
"awsSourceSchema": "string",
"awsTags": {
"{customized property}": "string"
},
"publicCloudConnectorsResourceId": "string",
"publicCloudResourceName": "string"
},
"tags": {
"{customized property}": "string"
}
}
속성 값
Microsoft.AwsConnector/appSyncGraphqlApis
| 이름 |
묘사 |
값 |
| API버전 |
api 버전 |
'2024-12-01' |
| 위치 |
리소스가 있는 지리적 위치 |
string(필수) |
| 이름 |
리소스 이름 |
문자열
제약 조건: 패턴 = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#])(필수) |
| 속성 |
이 리소스에 대한 리소스별 속성입니다. |
AppSyncGraphqlApiProperties |
| 태그 |
리소스 태그 |
태그 이름 및 값의 사전입니다. 템플릿 태그를 참조하세요. |
| 형 |
리소스 종류 |
'Microsoft.AwsConnector/appSyncGraphqlApis' |
추가 인증제공자
| 이름 |
묘사 |
값 |
| 인증유형 |
<p>인증 유형: API 키, IAM(ID 및 액세스 관리), OIDC(OpenID Connect), Amazon Cognito 사용자 풀 또는 람다입니다. /p<> |
AuthenticationTypeEnumValue |
| 람다AuthorizerConfig |
<p>람다 함수 권한 부여에 대한 구성입니다. /p<> |
람다AuthorizerConfig |
| openIDConnectConfig |
<p>OIDC 구성입니다. /p<> |
OpenIDConnectConfig |
| userPoolConfig |
<p>Amazon Cognito 사용자 풀 구성입니다. /p<> |
CognitoUserPoolConfig |
AppSyncGraphqlApi속성
| 이름 |
묘사 |
값 |
| 아른(ARN) |
ARN(Amazon Resource Name) |
문자열 |
| awsAccountId 님 |
AWS 계정 ID |
문자열 |
| aws속성 |
AWS 속성 |
AwsAppSyncGraphqlApi속성 |
| aws지역 |
AWS 지역 |
문자열 |
| awsSource스키마 |
AWS 원본 스키마 |
문자열 |
| aws태그 |
AWS 태그 |
AppSyncGraphqlApiPropertiesAws태그 |
| publicCloudConnectorsResourceId |
퍼블릭 클라우드 커넥터 리소스 ID |
문자열 |
| publicCloudResourceName |
퍼블릭 클라우드 리소스 이름 |
문자열 |
AuthenticationTypeEnumValue
| 이름 |
묘사 |
값 |
| 값 |
속성 값 |
'AMAZON_COGNITO_USER_POOLS' 'API_KEY' 'AWS_IAM' 'AWS_LAMBDA' 'OPENID_CONNECT' |
AwsAppSyncGraphqlApi속성
| 이름 |
묘사 |
값 |
| additionalAuthentication공급자 |
<p>GraphqlApi</code> API를<>코드에 대한 추가 인증 공급자 목록입니다.</p> |
추가 인증 제공자[] |
| apiId를 입력합니다. |
<p>API ID입니다.</p> |
문자열 |
| api유형 |
<p>GraphQL API가 표준 API(<코드>GRAPHQL</code>) 또는 병합된 API(MERGED</code><>코드)인지를 나타내는 값입니다.</p> |
GraphQLApiTypeEnumValue |
| 아른(ARN) |
<p>ARN(Amazon Resource Name)입니다. /p<> |
문자열 |
| 인증유형 |
<p>인증 유형입니다. /p<> |
AuthenticationTypeEnumValue |
| dns(dns) |
<p>API에 대한 DNS 레코드입니다. /p<> |
awsAppSyncGraphqlApiPropertiesDns |
| enhancedMetricsConfig |
<p><코드>enhancedMetricsConfig</code> 개체입니다.</p> |
EnhancedMetricsConfig |
| 인트로스펙션Config |
<p>GraphQL API의 값을 설정하여 (<코드>ENABLED</code>) 또는 비활성화(<코드>DISABLED</code>) 내성 검사를 사용하도록 설정합니다. 값이 제공되지 않으면 기본적으로 introspection 구성이 enablED</code><>코드로 설정됩니다. 이 필드는 이 필드를 사용하지 않도록 설정된 동안 작업에서 내성 기능을 사용하려고 하면 오류가 발생합니다.</p><p>>대한 자세한 내용은 href='https://graphql.org/learn/introspection/'>GraphQL 성찰</a><참조하세요.>/p |
GraphQLApiIntrospectionConfigEnumValue |
| 람다AuthorizerConfig |
<p>람다 함수 권한 부여에 대한 구성입니다. /p<> |
람다AuthorizerConfig |
| 로그 구성 |
<p>Amazon CloudWatch 로그 구성입니다. /p<> |
LogConfig |
| mergedApiExecutionRoleArn |
<p>병합된 API에 대한 ID 및 액세스 관리 서비스 역할 ARN입니다. AppSync 서비스는 병합된 API를 대신하여 이 역할을 사용하여 런타임에 원본 API에 대한 액세스의 유효성을 검사하고 <코드>AUTO_MERGE</code> 소스 API 변경 내용으로 병합된 API 엔드포인트를 자동으로 업데이트하라는 메시지를 표시합니다.</p> |
문자열 |
| 이름 |
<p>API 이름입니다. /p<> |
문자열 |
| openIDConnectConfig |
<p>OpenID Connect 구성입니다. /p<> |
OpenIDConnectConfig |
| 소유자 |
<p>GraphQL API의 계정 소유자입니다. /p<> |
문자열 |
| 소유자연락처 |
<p>API 리소스에 대한 소유자 연락처 정보입니다.</p><p>이 필드는 길이가 0~256자인 문자열 입력을 허용합니다.</p> |
문자열 |
| 쿼리 깊이 제한 |
<p>쿼리가 단일 요청에서 가질 수 있는 최대 수준입니다. 깊이는 쿼리 본문에 허용되는 중첩된 수준의 양을 나타냅니다. 기본값은 <코드>0</code>(또는 지정되지 않음)이며 이는 깊이 제한이 없음을 나타냅니다. 제한을 설정하는 경우 <코드>1</code> 코드와 <코드>75</code> 중첩된 수준 사이일 수 있습니다. 이 필드는 작업이 범위를 벗어나는 경우 제한 오류를 생성합니다.</p><p>필드는 여전히 nullable 또는 nullable이 아닌 필드로 설정할 수 있습니다. null을 허용하지 않는 필드에 오류가 발생하면 사용 가능한 첫 번째 null 허용 필드로 오류가 위쪽으로 throw됩니다.</p> |
정수 (int) |
| 리졸버CountLimit |
<p>단일 요청에서 호출할 수 있는 최대 확인자 수입니다. 기본값은 <코드>0</code>(또는 지정되지 않음)이며, <코드>10000</code>로 제한을 설정합니다. 지정된 경우 제한 값은 <코드>1</code> 및 <코드>10000</code>사이일 수 있습니다. 이 필드는 작업이 범위를 벗어나는 경우 제한 오류를 생성합니다.</p> |
정수 (int) |
| 태그 |
<p>태그입니다. /p<> |
awsAppSyncGraphqlApiProperties태그 |
| URI |
p<URI를 >. /p<> |
awsAppSyncGraphqlApiPropertiesUris |
| userPoolConfig |
<p>Amazon Cognito 사용자 풀 구성입니다. /p<> |
UserPoolConfig |
| 시정 |
<p>GraphQL API의 값을 public(<코드>GLOBAL</code>) 또는 private(private(<코드>PRIVATE</code>)으로 설정합니다. 값이 제공되지 않으면 표시 유형이 기본적으로 GLOBAL</code><>코드로 설정됩니다. API를 만든 후에는 이 값을 변경할 수 없습니다.</p> |
GraphQLApiVisibilityEnumValue |
| wafWebAclArn |
<p>GraphqlApi</code><이 >코드와 연결된 WAF ACL(액세스 제어 목록)의 ARN(있는 경우)입니다.</p> |
문자열 |
| 엑스레이 활성화 |
<p>GraphqlApi</code><이 >코드에 대해 X-Ray 추적을 사용할지 여부를 나타내는 플래그입니다.</p> |
bool |
awsAppSyncGraphqlApiPropertiesDns
AwsAppSyncGraphqlApiPropertiesUris
CognitoUserPoolConfig
| 이름 |
묘사 |
값 |
| appIdClientRegex |
<p>들어오는 Amazon Cognito 사용자 풀 앱 클라이언트 ID의 유효성을 검사하기 위한 정규식입니다. 이 값을 설정하지 않으면 필터링이 적용되지 않습니다.</p> |
문자열 |
| aws지역 |
<p>사용자 풀이 만들어진 Amazon Web Services 지역입니다. /p<> |
문자열 |
| userPoolId |
<p>사용자 풀 ID입니다.</p> |
문자열 |
DataSourceLevelMetricsBehaviorEnumValue
| 이름 |
묘사 |
값 |
| 값 |
속성 값 |
'FULL_REQUEST_DATA_SOURCE_METRICS' 'PER_DATA_SOURCE_METRICS' |
DefaultActionEnumValue
EnhancedMetricsConfig
| 이름 |
묘사 |
값 |
| dataSourceLevelMetrics동작 |
<p>데이터 원본 메트릭을 CloudWatch에 내보내는 방법을 제어합니다. 데이터 원본 메트릭에는</p><ul><li><p>요청: 요청 중에 발생한 호출 수입니다.</p></li><li><p>대기 시간: 데이터 원본 호출을 완료하는 시간입니다.</p></li><li><p>오류: 데이터 원본 호출 중에 발생한 오류 수입니다.</p></li></ul><p>이러한 메트릭은 데이터 원본당 또는 요청의 모든 데이터 원본에 대해 CloudWatch로 내보낼 수 있습니다. 메트릭은 API ID 및 데이터 원본 이름으로 기록됩니다.
<코드>dataSourceLevelMetricsBehavior</code></p><ul><li><p><코드>FULL_REQUEST_DATA_SOURCE_METRICS</code>: 요청의 모든 데이터 원본에 대한 메트릭 데이터를 기록하고 내보낸다.</p></li><li><p><코드>PER_DATA_SOURCE_METRICS</code>: <코드>metricsConfig</code> 값이 <코드>enablED</code>설정된 데이터 원본에 대한 메트릭 데이터를 기록하고 내보낸다.</p></li></ul> |
DataSourceLevelMetricsBehaviorEnumValue |
| operationLevelMetricsConfig |
<p> 작업 메트릭을 CloudWatch에 내보내는 방법을 제어합니다. 작업 메트릭에는</p><ul><li><p>요청: 지정된 GraphQL 작업이 호출된 횟수입니다.</p></li><li><p>GraphQL 오류: 지정된 GraphQL 작업 중에 발생한 GraphQL 오류 수입니다.</p></li></ul><p>메트릭은 API ID 및 작업 이름으로 기록됩니다. 값이 ENABLED</code><>코드 또는 <코드>DISABLED</code>>설정할 수 있습니다.>/p |
operationLevelMetricsConfigEnumValue |
| resolverLevelMetrics동작 |
<p>확인자 메트릭을 CloudWatch에 내보내는 방법을 제어합니다. 해결 프로그램 메트릭은 다음과 같습니다.</p><ul><li><p>GraphQL 오류: 발생한 GraphQL 오류 수입니다.</p></li><li><p>요청: 요청 중에 발생한 호출 수입니다.
</p></li><li><p>대기 시간: 해결 프로그램 호출을 완료하는 시간입니다.</p></li><li><p>Cache hits: 요청 중 캐시 적중 횟수입니다.</p></li><li><p>Cache 누락: 요청 중 캐시 누락 수입니다.</p></li></ul><p>이러한 메트릭은 확인자당 CloudWatch 또는 요청의 모든 확인자에 대해 내보낼 수 있습니다. 메트릭은 API ID 및 확인자 이름으로 기록됩니다.
<코드>resolverLevelMetricsBehavior</code></p><ul><li><p><코드>FULL_REQUEST_RESOLVER_METRICS</code>: 요청의 모든 확인자에 대한 메트릭 데이터를 기록하고 내보낸다.</p></li><li><p><코드>PER_RESOLVER_METRICS</code>: <코드>metricsConfig</code> 값이 enablED</code><코드 >로 설정된 확인자에 대한 메트릭 데이터를 기록하고 내보낸다.</p></li></ul> |
ResolverLevelMetricsBehaviorEnumValue |
FieldLogLevelEnumValue
| 이름 |
묘사 |
값 |
| 값 |
속성 값 |
'모두' '오류' '없음' |
GraphQLApiIntrospectionConfigEnumValue
| 이름 |
묘사 |
값 |
| 값 |
속성 값 |
'사용 안 함' '사용' |
GraphQLApiTypeEnumValue
| 이름 |
묘사 |
값 |
| 값 |
속성 값 |
'그래프QL' '병합됨' |
GraphQLApiVisibilityEnumValue
| 이름 |
묘사 |
값 |
| 값 |
속성 값 |
'글로벌' '비공개' |
람다AuthorizerConfig
| 이름 |
묘사 |
값 |
| authorizerResultTtlInSeconds |
<p>응답을 캐시해야 하는 시간(초)입니다. 기본값은 캐싱을 사용하지 않도록 설정하는 0초입니다.
<코드>authorizerResultTtlInSeconds</code>값을 지정하지 않으면 기본값이 사용됩니다. 최대값은 1시간(3600초)입니다. 람다 함수는 응답에서 ttlOverride</code> 키를<>코드를 반환하여 이를 재정의할 수 있습니다.</p> |
정수 (int) |
| authorizerUri |
<p>권한 부여를 위해 호출할 람다 함수의 ARN(Amazon Resource Name)입니다. 표준 람다 ARN, 버전 ARN(<코드>.../v3</code>) 또는 별칭 ARN일 수 있습니다.
</p><p><b>참고</b>: 이 람다 함수에는 다음 리소스 기반 정책이 할당되어 있어야 합니다. 콘솔에서 람다 권한 부여자를 구성할 때 이 작업이 수행됩니다. CLI(명령줄 인터페이스)를 사용하려면 다음을 실행합니다.</p><p><코드>aws lambda 추가 권한 --function-name 'arn:aws:lambda:us-east-2:111122223333:function:my-function' --statement-id 'appsync' --principal appsync.amazonaws.com --action lambda:InvokeFunction</code></p> |
문자열 |
| 신원 확인 표현식 |
<p>람다 함수가 호출되기 전에 토큰 유효성 검사를 위한 정규식입니다. /p<> |
문자열 |
로그 구성
| 이름 |
묘사 |
값 |
| cloudWatchLogs역할Arn |
<p>AppSync에서 계정의 CloudWatch 로그에 게시하는 것으로 가정하는 서비스 역할입니다. /p<> |
문자열 |
| excludeVerboseContent 제외 |
<p>로깅 수준에 관계없이 헤더, 컨텍스트 및 평가된 매핑 템플릿과 같은 정보가 포함된 섹션을 제외하려면 TRUE로 설정합니다. /p<> |
bool |
| 필드 로그 레벨 |
<p>필드 로깅 수준입니다. 값은 NONE, ERROR 또는 ALL일 수 있습니다.</p><ul><li><p><b>NONE</b>: 필드 수준 로그가 캡처되지 않습니다.</p></li><li><p><b>ERROR</b>:</p><ul><li><p>서버 응답의 오류 섹션입니다. /p<>/li<>li<>p<필드 수준 오류를>.</p></li><li><p>오류 필드에 대해 확인된 생성된 요청/응답 함수입니다.</p></li></ul></li><li><p><b>ALL</b>:</p><ul><li><p>필드 수준 추적 정보입니다.</p></li><li><p>각 필드에 대해 확인된 생성된 요청/응답 함수입니다.</p></li></ul></li></ul> |
fieldLogLevelEnumValue |
OpenIDConnectConfig
| 이름 |
묘사 |
값 |
| 인증 TTL |
<p>인증된 후 토큰이 유효한 시간(밀리초)입니다. /p<> |
정수 (int) |
| 클라이언트 ID |
<p>OpenID ID 공급자에서 신뢰 당사자의 클라이언트 식별자입니다. 이 식별자는 일반적으로 신뢰 당사자가 OpenID ID 공급자에 등록될 때 가져옵니다. AppSync가 한 번에 여러 클라이언트 식별자에 대해 유효성을 검사할 수 있도록 정규식을 지정할 수 있습니다.</p> |
문자열 |
| iatTTL |
<p>토큰이 사용자에게 발급된 후 유효한 시간(밀리초)입니다. /p<> |
정수 (int) |
| 발급자 |
<p>OIDC 구성에 대한 발급자입니다. 검색에서 반환된 발급자는 ID 토큰의</code><>코드 값과 정확히 일치해야 합니다.</p> |
문자열 |
OperationLevelMetricsConfigEnumValue
| 이름 |
묘사 |
값 |
| 값 |
속성 값 |
'사용 안 함' '사용' |
ResolverLevelMetricsBehaviorEnumValue
| 이름 |
묘사 |
값 |
| 값 |
속성 값 |
'FULL_REQUEST_RESOLVER_METRICS' 'PER_RESOLVER_METRICS' |
사용자 풀 구성
| 이름 |
묘사 |
값 |
| appIdClientRegex |
<p>들어오는 Amazon Cognito 사용자 풀 앱 클라이언트 ID의 유효성을 검사하기 위한 정규식입니다. 이 값을 설정하지 않으면 필터링이 적용되지 않습니다.</p> |
문자열 |
| aws지역 |
<p>사용자 풀이 만들어진 Amazon Web Services 지역입니다. /p<> |
문자열 |
| defaultAction |
<p>Amazon Cognito 사용자 풀 인증을 사용하는 요청이 Amazon Cognito 사용자 풀 구성과 일치하지 않을 때 GraphQL API에서 수행하려는 작업입니다. /p<> |
DefaultActionEnumValue |
| userPoolId |
<p>사용자 풀 ID입니다.</p> |
문자열 |
사용 예제
appSyncGraphqlApis 리소스 종류는 다음을 대상으로 하는 작업으로 배포할 수 있습니다.
각 API 버전에서 변경된 속성 목록은 변경 로그참조하세요.
Microsoft.AwsConnector/appSyncGraphqlApis 리소스를 만들려면 템플릿에 다음 Terraform을 추가합니다.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AwsConnector/appSyncGraphqlApis@2024-12-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
arn = "string"
awsAccountId = "string"
awsProperties = {
additionalAuthenticationProviders = [
{
authenticationType = {
value = "string"
}
lambdaAuthorizerConfig = {
authorizerResultTtlInSeconds = int
authorizerUri = "string"
identityValidationExpression = "string"
}
openIDConnectConfig = {
authTTL = int
clientId = "string"
iatTTL = int
issuer = "string"
}
userPoolConfig = {
appIdClientRegex = "string"
awsRegion = "string"
userPoolId = "string"
}
}
]
apiId = "string"
apiType = {
value = "string"
}
arn = "string"
authenticationType = {
value = "string"
}
dns = {
{customized property} = "string"
}
enhancedMetricsConfig = {
dataSourceLevelMetricsBehavior = {
value = "string"
}
operationLevelMetricsConfig = {
value = "string"
}
resolverLevelMetricsBehavior = {
value = "string"
}
}
introspectionConfig = {
value = "string"
}
lambdaAuthorizerConfig = {
authorizerResultTtlInSeconds = int
authorizerUri = "string"
identityValidationExpression = "string"
}
logConfig = {
cloudWatchLogsRoleArn = "string"
excludeVerboseContent = bool
fieldLogLevel = {
value = "string"
}
}
mergedApiExecutionRoleArn = "string"
name = "string"
openIDConnectConfig = {
authTTL = int
clientId = "string"
iatTTL = int
issuer = "string"
}
owner = "string"
ownerContact = "string"
queryDepthLimit = int
resolverCountLimit = int
tags = {
{customized property} = "string"
}
uris = {
{customized property} = "string"
}
userPoolConfig = {
appIdClientRegex = "string"
awsRegion = "string"
defaultAction = {
value = "string"
}
userPoolId = "string"
}
visibility = {
value = "string"
}
wafWebAclArn = "string"
xrayEnabled = bool
}
awsRegion = "string"
awsSourceSchema = "string"
awsTags = {
{customized property} = "string"
}
publicCloudConnectorsResourceId = "string"
publicCloudResourceName = "string"
}
}
}
속성 값
Microsoft.AwsConnector/appSyncGraphqlApis
| 이름 |
묘사 |
값 |
| 위치 |
리소스가 있는 지리적 위치 |
string(필수) |
| 이름 |
리소스 이름 |
문자열
제약 조건: 패턴 = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#])(필수) |
| 속성 |
이 리소스에 대한 리소스별 속성입니다. |
AppSyncGraphqlApiProperties |
| 태그 |
리소스 태그 |
태그 이름 및 값의 사전입니다. |
| 형 |
리소스 종류 |
"Microsoft.AwsConnector/appSyncGraphqlApis@2024-12-01" |
추가 인증제공자
| 이름 |
묘사 |
값 |
| 인증유형 |
<p>인증 유형: API 키, IAM(ID 및 액세스 관리), OIDC(OpenID Connect), Amazon Cognito 사용자 풀 또는 람다입니다. /p<> |
AuthenticationTypeEnumValue |
| 람다AuthorizerConfig |
<p>람다 함수 권한 부여에 대한 구성입니다. /p<> |
람다AuthorizerConfig |
| openIDConnectConfig |
<p>OIDC 구성입니다. /p<> |
OpenIDConnectConfig |
| userPoolConfig |
<p>Amazon Cognito 사용자 풀 구성입니다. /p<> |
CognitoUserPoolConfig |
AppSyncGraphqlApi속성
| 이름 |
묘사 |
값 |
| 아른(ARN) |
ARN(Amazon Resource Name) |
문자열 |
| awsAccountId 님 |
AWS 계정 ID |
문자열 |
| aws속성 |
AWS 속성 |
AwsAppSyncGraphqlApi속성 |
| aws지역 |
AWS 지역 |
문자열 |
| awsSource스키마 |
AWS 원본 스키마 |
문자열 |
| aws태그 |
AWS 태그 |
AppSyncGraphqlApiPropertiesAws태그 |
| publicCloudConnectorsResourceId |
퍼블릭 클라우드 커넥터 리소스 ID |
문자열 |
| publicCloudResourceName |
퍼블릭 클라우드 리소스 이름 |
문자열 |
AuthenticationTypeEnumValue
| 이름 |
묘사 |
값 |
| 값 |
속성 값 |
'AMAZON_COGNITO_USER_POOLS' 'API_KEY' 'AWS_IAM' 'AWS_LAMBDA' 'OPENID_CONNECT' |
AwsAppSyncGraphqlApi속성
| 이름 |
묘사 |
값 |
| additionalAuthentication공급자 |
<p>GraphqlApi</code> API를<>코드에 대한 추가 인증 공급자 목록입니다.</p> |
추가 인증 제공자[] |
| apiId를 입력합니다. |
<p>API ID입니다.</p> |
문자열 |
| api유형 |
<p>GraphQL API가 표준 API(<코드>GRAPHQL</code>) 또는 병합된 API(MERGED</code><>코드)인지를 나타내는 값입니다.</p> |
GraphQLApiTypeEnumValue |
| 아른(ARN) |
<p>ARN(Amazon Resource Name)입니다. /p<> |
문자열 |
| 인증유형 |
<p>인증 유형입니다. /p<> |
AuthenticationTypeEnumValue |
| dns(dns) |
<p>API에 대한 DNS 레코드입니다. /p<> |
awsAppSyncGraphqlApiPropertiesDns |
| enhancedMetricsConfig |
<p><코드>enhancedMetricsConfig</code> 개체입니다.</p> |
EnhancedMetricsConfig |
| 인트로스펙션Config |
<p>GraphQL API의 값을 설정하여 (<코드>ENABLED</code>) 또는 비활성화(<코드>DISABLED</code>) 내성 검사를 사용하도록 설정합니다. 값이 제공되지 않으면 기본적으로 introspection 구성이 enablED</code><>코드로 설정됩니다. 이 필드는 이 필드를 사용하지 않도록 설정된 동안 작업에서 내성 기능을 사용하려고 하면 오류가 발생합니다.</p><p>>대한 자세한 내용은 href='https://graphql.org/learn/introspection/'>GraphQL 성찰</a><참조하세요.>/p |
GraphQLApiIntrospectionConfigEnumValue |
| 람다AuthorizerConfig |
<p>람다 함수 권한 부여에 대한 구성입니다. /p<> |
람다AuthorizerConfig |
| 로그 구성 |
<p>Amazon CloudWatch 로그 구성입니다. /p<> |
LogConfig |
| mergedApiExecutionRoleArn |
<p>병합된 API에 대한 ID 및 액세스 관리 서비스 역할 ARN입니다. AppSync 서비스는 병합된 API를 대신하여 이 역할을 사용하여 런타임에 원본 API에 대한 액세스의 유효성을 검사하고 <코드>AUTO_MERGE</code> 소스 API 변경 내용으로 병합된 API 엔드포인트를 자동으로 업데이트하라는 메시지를 표시합니다.</p> |
문자열 |
| 이름 |
<p>API 이름입니다. /p<> |
문자열 |
| openIDConnectConfig |
<p>OpenID Connect 구성입니다. /p<> |
OpenIDConnectConfig |
| 소유자 |
<p>GraphQL API의 계정 소유자입니다. /p<> |
문자열 |
| 소유자연락처 |
<p>API 리소스에 대한 소유자 연락처 정보입니다.</p><p>이 필드는 길이가 0~256자인 문자열 입력을 허용합니다.</p> |
문자열 |
| 쿼리 깊이 제한 |
<p>쿼리가 단일 요청에서 가질 수 있는 최대 수준입니다. 깊이는 쿼리 본문에 허용되는 중첩된 수준의 양을 나타냅니다. 기본값은 <코드>0</code>(또는 지정되지 않음)이며 이는 깊이 제한이 없음을 나타냅니다. 제한을 설정하는 경우 <코드>1</code> 코드와 <코드>75</code> 중첩된 수준 사이일 수 있습니다. 이 필드는 작업이 범위를 벗어나는 경우 제한 오류를 생성합니다.</p><p>필드는 여전히 nullable 또는 nullable이 아닌 필드로 설정할 수 있습니다. null을 허용하지 않는 필드에 오류가 발생하면 사용 가능한 첫 번째 null 허용 필드로 오류가 위쪽으로 throw됩니다.</p> |
정수 (int) |
| 리졸버CountLimit |
<p>단일 요청에서 호출할 수 있는 최대 확인자 수입니다. 기본값은 <코드>0</code>(또는 지정되지 않음)이며, <코드>10000</code>로 제한을 설정합니다. 지정된 경우 제한 값은 <코드>1</code> 및 <코드>10000</code>사이일 수 있습니다. 이 필드는 작업이 범위를 벗어나는 경우 제한 오류를 생성합니다.</p> |
정수 (int) |
| 태그 |
<p>태그입니다. /p<> |
awsAppSyncGraphqlApiProperties태그 |
| URI |
p<URI를 >. /p<> |
awsAppSyncGraphqlApiPropertiesUris |
| userPoolConfig |
<p>Amazon Cognito 사용자 풀 구성입니다. /p<> |
UserPoolConfig |
| 시정 |
<p>GraphQL API의 값을 public(<코드>GLOBAL</code>) 또는 private(private(<코드>PRIVATE</code>)으로 설정합니다. 값이 제공되지 않으면 표시 유형이 기본적으로 GLOBAL</code><>코드로 설정됩니다. API를 만든 후에는 이 값을 변경할 수 없습니다.</p> |
GraphQLApiVisibilityEnumValue |
| wafWebAclArn |
<p>GraphqlApi</code><이 >코드와 연결된 WAF ACL(액세스 제어 목록)의 ARN(있는 경우)입니다.</p> |
문자열 |
| 엑스레이 활성화 |
<p>GraphqlApi</code><이 >코드에 대해 X-Ray 추적을 사용할지 여부를 나타내는 플래그입니다.</p> |
bool |
awsAppSyncGraphqlApiPropertiesDns
AwsAppSyncGraphqlApiPropertiesUris
CognitoUserPoolConfig
| 이름 |
묘사 |
값 |
| appIdClientRegex |
<p>들어오는 Amazon Cognito 사용자 풀 앱 클라이언트 ID의 유효성을 검사하기 위한 정규식입니다. 이 값을 설정하지 않으면 필터링이 적용되지 않습니다.</p> |
문자열 |
| aws지역 |
<p>사용자 풀이 만들어진 Amazon Web Services 지역입니다. /p<> |
문자열 |
| userPoolId |
<p>사용자 풀 ID입니다.</p> |
문자열 |
DataSourceLevelMetricsBehaviorEnumValue
| 이름 |
묘사 |
값 |
| 값 |
속성 값 |
'FULL_REQUEST_DATA_SOURCE_METRICS' 'PER_DATA_SOURCE_METRICS' |
DefaultActionEnumValue
EnhancedMetricsConfig
| 이름 |
묘사 |
값 |
| dataSourceLevelMetrics동작 |
<p>데이터 원본 메트릭을 CloudWatch에 내보내는 방법을 제어합니다. 데이터 원본 메트릭에는</p><ul><li><p>요청: 요청 중에 발생한 호출 수입니다.</p></li><li><p>대기 시간: 데이터 원본 호출을 완료하는 시간입니다.</p></li><li><p>오류: 데이터 원본 호출 중에 발생한 오류 수입니다.</p></li></ul><p>이러한 메트릭은 데이터 원본당 또는 요청의 모든 데이터 원본에 대해 CloudWatch로 내보낼 수 있습니다. 메트릭은 API ID 및 데이터 원본 이름으로 기록됩니다.
<코드>dataSourceLevelMetricsBehavior</code></p><ul><li><p><코드>FULL_REQUEST_DATA_SOURCE_METRICS</code>: 요청의 모든 데이터 원본에 대한 메트릭 데이터를 기록하고 내보낸다.</p></li><li><p><코드>PER_DATA_SOURCE_METRICS</code>: <코드>metricsConfig</code> 값이 <코드>enablED</code>설정된 데이터 원본에 대한 메트릭 데이터를 기록하고 내보낸다.</p></li></ul> |
DataSourceLevelMetricsBehaviorEnumValue |
| operationLevelMetricsConfig |
<p> 작업 메트릭을 CloudWatch에 내보내는 방법을 제어합니다. 작업 메트릭에는</p><ul><li><p>요청: 지정된 GraphQL 작업이 호출된 횟수입니다.</p></li><li><p>GraphQL 오류: 지정된 GraphQL 작업 중에 발생한 GraphQL 오류 수입니다.</p></li></ul><p>메트릭은 API ID 및 작업 이름으로 기록됩니다. 값이 ENABLED</code><>코드 또는 <코드>DISABLED</code>>설정할 수 있습니다.>/p |
operationLevelMetricsConfigEnumValue |
| resolverLevelMetrics동작 |
<p>확인자 메트릭을 CloudWatch에 내보내는 방법을 제어합니다. 해결 프로그램 메트릭은 다음과 같습니다.</p><ul><li><p>GraphQL 오류: 발생한 GraphQL 오류 수입니다.</p></li><li><p>요청: 요청 중에 발생한 호출 수입니다.
</p></li><li><p>대기 시간: 해결 프로그램 호출을 완료하는 시간입니다.</p></li><li><p>Cache hits: 요청 중 캐시 적중 횟수입니다.</p></li><li><p>Cache 누락: 요청 중 캐시 누락 수입니다.</p></li></ul><p>이러한 메트릭은 확인자당 CloudWatch 또는 요청의 모든 확인자에 대해 내보낼 수 있습니다. 메트릭은 API ID 및 확인자 이름으로 기록됩니다.
<코드>resolverLevelMetricsBehavior</code></p><ul><li><p><코드>FULL_REQUEST_RESOLVER_METRICS</code>: 요청의 모든 확인자에 대한 메트릭 데이터를 기록하고 내보낸다.</p></li><li><p><코드>PER_RESOLVER_METRICS</code>: <코드>metricsConfig</code> 값이 enablED</code><코드 >로 설정된 확인자에 대한 메트릭 데이터를 기록하고 내보낸다.</p></li></ul> |
ResolverLevelMetricsBehaviorEnumValue |
FieldLogLevelEnumValue
| 이름 |
묘사 |
값 |
| 값 |
속성 값 |
'모두' '오류' '없음' |
GraphQLApiIntrospectionConfigEnumValue
| 이름 |
묘사 |
값 |
| 값 |
속성 값 |
'사용 안 함' '사용' |
GraphQLApiTypeEnumValue
| 이름 |
묘사 |
값 |
| 값 |
속성 값 |
'그래프QL' '병합됨' |
GraphQLApiVisibilityEnumValue
| 이름 |
묘사 |
값 |
| 값 |
속성 값 |
'글로벌' '비공개' |
람다AuthorizerConfig
| 이름 |
묘사 |
값 |
| authorizerResultTtlInSeconds |
<p>응답을 캐시해야 하는 시간(초)입니다. 기본값은 캐싱을 사용하지 않도록 설정하는 0초입니다.
<코드>authorizerResultTtlInSeconds</code>값을 지정하지 않으면 기본값이 사용됩니다. 최대값은 1시간(3600초)입니다. 람다 함수는 응답에서 ttlOverride</code> 키를<>코드를 반환하여 이를 재정의할 수 있습니다.</p> |
정수 (int) |
| authorizerUri |
<p>권한 부여를 위해 호출할 람다 함수의 ARN(Amazon Resource Name)입니다. 표준 람다 ARN, 버전 ARN(<코드>.../v3</code>) 또는 별칭 ARN일 수 있습니다.
</p><p><b>참고</b>: 이 람다 함수에는 다음 리소스 기반 정책이 할당되어 있어야 합니다. 콘솔에서 람다 권한 부여자를 구성할 때 이 작업이 수행됩니다. CLI(명령줄 인터페이스)를 사용하려면 다음을 실행합니다.</p><p><코드>aws lambda 추가 권한 --function-name 'arn:aws:lambda:us-east-2:111122223333:function:my-function' --statement-id 'appsync' --principal appsync.amazonaws.com --action lambda:InvokeFunction</code></p> |
문자열 |
| 신원 확인 표현식 |
<p>람다 함수가 호출되기 전에 토큰 유효성 검사를 위한 정규식입니다. /p<> |
문자열 |
로그 구성
| 이름 |
묘사 |
값 |
| cloudWatchLogs역할Arn |
<p>AppSync에서 계정의 CloudWatch 로그에 게시하는 것으로 가정하는 서비스 역할입니다. /p<> |
문자열 |
| excludeVerboseContent 제외 |
<p>로깅 수준에 관계없이 헤더, 컨텍스트 및 평가된 매핑 템플릿과 같은 정보가 포함된 섹션을 제외하려면 TRUE로 설정합니다. /p<> |
bool |
| 필드 로그 레벨 |
<p>필드 로깅 수준입니다. 값은 NONE, ERROR 또는 ALL일 수 있습니다.</p><ul><li><p><b>NONE</b>: 필드 수준 로그가 캡처되지 않습니다.</p></li><li><p><b>ERROR</b>:</p><ul><li><p>서버 응답의 오류 섹션입니다. /p<>/li<>li<>p<필드 수준 오류를>.</p></li><li><p>오류 필드에 대해 확인된 생성된 요청/응답 함수입니다.</p></li></ul></li><li><p><b>ALL</b>:</p><ul><li><p>필드 수준 추적 정보입니다.</p></li><li><p>각 필드에 대해 확인된 생성된 요청/응답 함수입니다.</p></li></ul></li></ul> |
fieldLogLevelEnumValue |
OpenIDConnectConfig
| 이름 |
묘사 |
값 |
| 인증 TTL |
<p>인증된 후 토큰이 유효한 시간(밀리초)입니다. /p<> |
정수 (int) |
| 클라이언트 ID |
<p>OpenID ID 공급자에서 신뢰 당사자의 클라이언트 식별자입니다. 이 식별자는 일반적으로 신뢰 당사자가 OpenID ID 공급자에 등록될 때 가져옵니다. AppSync가 한 번에 여러 클라이언트 식별자에 대해 유효성을 검사할 수 있도록 정규식을 지정할 수 있습니다.</p> |
문자열 |
| iatTTL |
<p>토큰이 사용자에게 발급된 후 유효한 시간(밀리초)입니다. /p<> |
정수 (int) |
| 발급자 |
<p>OIDC 구성에 대한 발급자입니다. 검색에서 반환된 발급자는 ID 토큰의</code><>코드 값과 정확히 일치해야 합니다.</p> |
문자열 |
OperationLevelMetricsConfigEnumValue
| 이름 |
묘사 |
값 |
| 값 |
속성 값 |
'사용 안 함' '사용' |
ResolverLevelMetricsBehaviorEnumValue
| 이름 |
묘사 |
값 |
| 값 |
속성 값 |
'FULL_REQUEST_RESOLVER_METRICS' 'PER_RESOLVER_METRICS' |
사용자 풀 구성
| 이름 |
묘사 |
값 |
| appIdClientRegex |
<p>들어오는 Amazon Cognito 사용자 풀 앱 클라이언트 ID의 유효성을 검사하기 위한 정규식입니다. 이 값을 설정하지 않으면 필터링이 적용되지 않습니다.</p> |
문자열 |
| aws지역 |
<p>사용자 풀이 만들어진 Amazon Web Services 지역입니다. /p<> |
문자열 |
| defaultAction |
<p>Amazon Cognito 사용자 풀 인증을 사용하는 요청이 Amazon Cognito 사용자 풀 구성과 일치하지 않을 때 GraphQL API에서 수행하려는 작업입니다. /p<> |
DefaultActionEnumValue |
| userPoolId |
<p>사용자 풀 ID입니다.</p> |
문자열 |