CfnGraphQLApiProps¶
-
class
aws_cdk.aws_appsync.
CfnGraphQLApiProps
(*, authentication_type, name, additional_authentication_providers=None, lambda_authorizer_config=None, log_config=None, open_id_connect_config=None, tags=None, user_pool_config=None, xray_enabled=None)¶ Bases:
object
Properties for defining a
CfnGraphQLApi
.- Parameters
authentication_type (
str
) – Security configuration for your GraphQL API. For allowed values (such asAPI_KEY
,AWS_IAM
,AMAZON_COGNITO_USER_POOLS
,OPENID_CONNECT
, orAWS_LAMBDA
), see Security in the AWS AppSync Developer Guide .name (
str
) – The API name.additional_authentication_providers (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,AdditionalAuthenticationProviderProperty
,Dict
[str
,Any
]]],None
]) – A list of additional authentication providers for theGraphqlApi
API.lambda_authorizer_config (
Union
[IResolvable
,LambdaAuthorizerConfigProperty
,Dict
[str
,Any
],None
]) – ALambdaAuthorizerConfig
holds configuration on how to authorize AWS AppSync API access when using theAWS_LAMBDA
authorizer mode. Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time.log_config (
Union
[IResolvable
,LogConfigProperty
,Dict
[str
,Any
],None
]) – The Amazon CloudWatch Logs configuration.open_id_connect_config (
Union
[IResolvable
,OpenIDConnectConfigProperty
,Dict
[str
,Any
],None
]) – The OpenID Connect configuration.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – An arbitrary set of tags (key-value pairs) for this GraphQL API.user_pool_config (
Union
[IResolvable
,UserPoolConfigProperty
,Dict
[str
,Any
],None
]) – Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.xray_enabled (
Union
[bool
,IResolvable
,None
]) – A flag indicating whether to use AWS X-Ray tracing for thisGraphqlApi
.
- Link
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appsync as appsync cfn_graph_qLApi_props = appsync.CfnGraphQLApiProps( authentication_type="authenticationType", name="name", # the properties below are optional additional_authentication_providers=[appsync.CfnGraphQLApi.AdditionalAuthenticationProviderProperty( authentication_type="authenticationType", # the properties below are optional lambda_authorizer_config=appsync.CfnGraphQLApi.LambdaAuthorizerConfigProperty( authorizer_result_ttl_in_seconds=123, authorizer_uri="authorizerUri", identity_validation_expression="identityValidationExpression" ), open_id_connect_config=appsync.CfnGraphQLApi.OpenIDConnectConfigProperty( auth_ttl=123, client_id="clientId", iat_ttl=123, issuer="issuer" ), user_pool_config=appsync.CfnGraphQLApi.CognitoUserPoolConfigProperty( app_id_client_regex="appIdClientRegex", aws_region="awsRegion", user_pool_id="userPoolId" ) )], lambda_authorizer_config=appsync.CfnGraphQLApi.LambdaAuthorizerConfigProperty( authorizer_result_ttl_in_seconds=123, authorizer_uri="authorizerUri", identity_validation_expression="identityValidationExpression" ), log_config=appsync.CfnGraphQLApi.LogConfigProperty( cloud_watch_logs_role_arn="cloudWatchLogsRoleArn", exclude_verbose_content=False, field_log_level="fieldLogLevel" ), open_id_connect_config=appsync.CfnGraphQLApi.OpenIDConnectConfigProperty( auth_ttl=123, client_id="clientId", iat_ttl=123, issuer="issuer" ), tags=[CfnTag( key="key", value="value" )], user_pool_config=appsync.CfnGraphQLApi.UserPoolConfigProperty( app_id_client_regex="appIdClientRegex", aws_region="awsRegion", default_action="defaultAction", user_pool_id="userPoolId" ), xray_enabled=False )
Attributes
-
additional_authentication_providers
¶ A list of additional authentication providers for the
GraphqlApi
API.
-
authentication_type
¶ Security configuration for your GraphQL API.
For allowed values (such as
API_KEY
,AWS_IAM
,AMAZON_COGNITO_USER_POOLS
,OPENID_CONNECT
, orAWS_LAMBDA
), see Security in the AWS AppSync Developer Guide .
A
LambdaAuthorizerConfig
holds configuration on how to authorize AWS AppSync API access when using theAWS_LAMBDA
authorizer mode.Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time.
-
log_config
¶ The Amazon CloudWatch Logs configuration.
-
name
¶ The API name.
-
open_id_connect_config
¶ The OpenID Connect configuration.
An arbitrary set of tags (key-value pairs) for this GraphQL API.
- Link
- Return type
Optional
[List
[CfnTag
]]
-
user_pool_config
¶ Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
-
xray_enabled
¶ A flag indicating whether to use AWS X-Ray tracing for this
GraphqlApi
.- Link
- Return type
Union
[bool
,IResolvable
,None
]