GraphqlApi ¶

class GraphqlApi(TypedDict, closed=True):
    name: NotRequired["capo_appsync.types.resource_name.ResourceName"]
    """<p>The API name.</p>"""
    api_id: NotRequired["capo_appsync.types.string.String"]
    """<p>The API ID.</p>"""
    authentication_type: NotRequired[
        "capo_appsync.types.authentication_type.AuthenticationType"
    ]
    """<p>The authentication type.</p>"""
    log_config: NotRequired["capo_appsync.types.log_config.LogConfig"]
    """<p>The Amazon CloudWatch Logs configuration.</p>"""
    user_pool_config: NotRequired["capo_appsync.types.user_pool_config.UserPoolConfig"]
    """<p>The Amazon Cognito user pool configuration.</p>"""
    open_id_connect_config: NotRequired[
        "capo_appsync.types.open_id_connect_config.OpenIDConnectConfig"
    ]
    """<p>The OpenID Connect configuration.</p>"""
    arn: NotRequired["capo_appsync.types.string.String"]
    """<p>The Amazon Resource Name (ARN).</p>"""
    uris: NotRequired["capo_appsync.types.map_of_string_to_string.MapOfStringToString"]
    """<p>The URIs.</p>"""
    tags: NotRequired["capo_appsync.types.tag_map.TagMap"]
    """<p>The tags.</p>"""
    additional_authentication_providers: NotRequired[
        "capo_appsync.types.additional_authentication_providers.AdditionalAuthenticationProviders"
    ]
    """<p>A list of additional authentication providers for the <code>GraphqlApi</code> API.</p>"""
    xray_enabled: "capo_appsync.types.boolean.Boolean"
    """<p>A flag indicating whether to use X-Ray tracing for this <code>GraphqlApi</code>.</p>"""
    waf_web_acl_arn: NotRequired["capo_appsync.types.string.String"]
    """<p>The ARN of the WAF access control list (ACL) associated with this <code>GraphqlApi</code>, if one exists.</p>"""
    lambda_authorizer_config: NotRequired[
        "capo_appsync.types.lambda_authorizer_config.LambdaAuthorizerConfig"
    ]
    """<p>Configuration for Lambda function authorization.</p>"""
    dns: NotRequired["capo_appsync.types.map_of_string_to_string.MapOfStringToString"]
    """<p>The DNS records for the API.</p>"""
    visibility: NotRequired[
        "capo_appsync.types.graph_ql_api_visibility.GraphQLApiVisibility"
    ]
    """<p>Sets the value of the GraphQL API to public (<code>GLOBAL</code>) or private (<code>PRIVATE</code>). If no value is provided, the visibility will be set to <code>GLOBAL</code> by default. This value cannot be changed once the API has been created.</p>"""
    api_type: NotRequired["capo_appsync.types.graph_ql_api_type.GraphQLApiType"]
    """<p>The value that indicates whether the GraphQL API is a standard API (<code>GRAPHQL</code>) or merged API (<code>MERGED</code>).</p>"""
    merged_api_execution_role_arn: NotRequired["capo_appsync.types.string.String"]
    """<p>The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the <code>AUTO_MERGE</code> to update the merged API endpoint with the source API changes automatically.</p>"""
    owner: NotRequired["capo_appsync.types.string.String"]
    """<p>The account owner of the GraphQL API.</p>"""
    owner_contact: NotRequired["capo_appsync.types.string.String"]
    """<p>The owner contact information for an API resource.</p> <p>This field accepts any string input with a length of 0 - 256 characters.</p>"""
    introspection_config: NotRequired[
        "capo_appsync.types.graph_ql_api_introspection_config.GraphQLApiIntrospectionConfig"
    ]
    """<p>Sets the value of the GraphQL API to enable (<code>ENABLED</code>) or disable (<code>DISABLED</code>) introspection. If no value is provided, the introspection configuration will be set to <code>ENABLED</code> by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.</p> <p>For more information about introspection, see <a href="https://graphql.org/learn/introspection/">GraphQL introspection</a>.</p>"""
    query_depth_limit: "capo_appsync.types.query_depth_limit.QueryDepthLimit"
    """<p>The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is <code>0</code> (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between <code>1</code> and <code>75</code> nested levels. This field will produce a limit error if the operation falls out of bounds.</p> <p>Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.</p>"""
    resolver_count_limit: "capo_appsync.types.resolver_count_limit.ResolverCountLimit"
    """<p>The maximum number of resolvers that can be invoked in a single request. The default value is <code>0</code> (or unspecified), which will set the limit to <code>10000</code>. When specified, the limit value can be between <code>1</code> and <code>10000</code>. This field will produce a limit error if the operation falls out of bounds.</p>"""
    enhanced_metrics_config: NotRequired[
        "capo_appsync.types.enhanced_metrics_config.EnhancedMetricsConfig"
    ]
    """<p>The <code>enhancedMetricsConfig</code> object.</p>"""