Class: Aws::AppSync::Types::UpdateGraphqlApiRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::AppSync::Types::UpdateGraphqlApiRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-appsync/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#additional_authentication_providers ⇒ Array<Types::AdditionalAuthenticationProvider>
A list of additional authentication providers for the ‘GraphqlApi` API.
-
#api_id ⇒ String
The API ID.
-
#authentication_type ⇒ String
The new authentication type for the ‘GraphqlApi` object.
-
#enhanced_metrics_config ⇒ Types::EnhancedMetricsConfig
The ‘enhancedMetricsConfig` object.
-
#introspection_config ⇒ String
Sets the value of the GraphQL API to enable (‘ENABLED`) or disable (`DISABLED`) introspection.
-
#lambda_authorizer_config ⇒ Types::LambdaAuthorizerConfig
Configuration for Lambda function authorization.
-
#log_config ⇒ Types::LogConfig
The Amazon CloudWatch Logs configuration for the ‘GraphqlApi` object.
-
#merged_api_execution_role_arn ⇒ String
The Identity and Access Management service role ARN for a merged API.
-
#name ⇒ String
The new name for the ‘GraphqlApi` object.
-
#open_id_connect_config ⇒ Types::OpenIDConnectConfig
The OpenID Connect configuration for the ‘GraphqlApi` object.
-
#owner_contact ⇒ String
The owner contact information for an API resource.
-
#query_depth_limit ⇒ Integer
The maximum depth a query can have in a single request.
-
#resolver_count_limit ⇒ Integer
The maximum number of resolvers that can be invoked in a single request.
-
#user_pool_config ⇒ Types::UserPoolConfig
The new Amazon Cognito user pool configuration for the ‘~GraphqlApi` object.
-
#xray_enabled ⇒ Boolean
A flag indicating whether to use X-Ray tracing for the ‘GraphqlApi`.
Instance Attribute Details
#additional_authentication_providers ⇒ Array<Types::AdditionalAuthenticationProvider>
A list of additional authentication providers for the ‘GraphqlApi` API.
4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 |
# File 'lib/aws-sdk-appsync/types.rb', line 4819 class UpdateGraphqlApiRequest < Struct.new( :api_id, :name, :log_config, :authentication_type, :user_pool_config, :open_id_connect_config, :additional_authentication_providers, :xray_enabled, :lambda_authorizer_config, :merged_api_execution_role_arn, :owner_contact, :introspection_config, :query_depth_limit, :resolver_count_limit, :enhanced_metrics_config) SENSITIVE = [] include Aws::Structure end |
#api_id ⇒ String
The API ID.
4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 |
# File 'lib/aws-sdk-appsync/types.rb', line 4819 class UpdateGraphqlApiRequest < Struct.new( :api_id, :name, :log_config, :authentication_type, :user_pool_config, :open_id_connect_config, :additional_authentication_providers, :xray_enabled, :lambda_authorizer_config, :merged_api_execution_role_arn, :owner_contact, :introspection_config, :query_depth_limit, :resolver_count_limit, :enhanced_metrics_config) SENSITIVE = [] include Aws::Structure end |
#authentication_type ⇒ String
The new authentication type for the ‘GraphqlApi` object.
4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 |
# File 'lib/aws-sdk-appsync/types.rb', line 4819 class UpdateGraphqlApiRequest < Struct.new( :api_id, :name, :log_config, :authentication_type, :user_pool_config, :open_id_connect_config, :additional_authentication_providers, :xray_enabled, :lambda_authorizer_config, :merged_api_execution_role_arn, :owner_contact, :introspection_config, :query_depth_limit, :resolver_count_limit, :enhanced_metrics_config) SENSITIVE = [] include Aws::Structure end |
#enhanced_metrics_config ⇒ Types::EnhancedMetricsConfig
The ‘enhancedMetricsConfig` object.
4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 |
# File 'lib/aws-sdk-appsync/types.rb', line 4819 class UpdateGraphqlApiRequest < Struct.new( :api_id, :name, :log_config, :authentication_type, :user_pool_config, :open_id_connect_config, :additional_authentication_providers, :xray_enabled, :lambda_authorizer_config, :merged_api_execution_role_arn, :owner_contact, :introspection_config, :query_depth_limit, :resolver_count_limit, :enhanced_metrics_config) SENSITIVE = [] include Aws::Structure end |
#introspection_config ⇒ String
Sets the value of the GraphQL API to enable (‘ENABLED`) or disable (`DISABLED`) introspection. If no value is provided, the introspection configuration will be set to `ENABLED` by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.
For more information about introspection, see [GraphQL introspection].
4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 |
# File 'lib/aws-sdk-appsync/types.rb', line 4819 class UpdateGraphqlApiRequest < Struct.new( :api_id, :name, :log_config, :authentication_type, :user_pool_config, :open_id_connect_config, :additional_authentication_providers, :xray_enabled, :lambda_authorizer_config, :merged_api_execution_role_arn, :owner_contact, :introspection_config, :query_depth_limit, :resolver_count_limit, :enhanced_metrics_config) SENSITIVE = [] include Aws::Structure end |
#lambda_authorizer_config ⇒ Types::LambdaAuthorizerConfig
Configuration for Lambda function authorization.
4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 |
# File 'lib/aws-sdk-appsync/types.rb', line 4819 class UpdateGraphqlApiRequest < Struct.new( :api_id, :name, :log_config, :authentication_type, :user_pool_config, :open_id_connect_config, :additional_authentication_providers, :xray_enabled, :lambda_authorizer_config, :merged_api_execution_role_arn, :owner_contact, :introspection_config, :query_depth_limit, :resolver_count_limit, :enhanced_metrics_config) SENSITIVE = [] include Aws::Structure end |
#log_config ⇒ Types::LogConfig
The Amazon CloudWatch Logs configuration for the ‘GraphqlApi` object.
4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 |
# File 'lib/aws-sdk-appsync/types.rb', line 4819 class UpdateGraphqlApiRequest < Struct.new( :api_id, :name, :log_config, :authentication_type, :user_pool_config, :open_id_connect_config, :additional_authentication_providers, :xray_enabled, :lambda_authorizer_config, :merged_api_execution_role_arn, :owner_contact, :introspection_config, :query_depth_limit, :resolver_count_limit, :enhanced_metrics_config) SENSITIVE = [] include Aws::Structure end |
#merged_api_execution_role_arn ⇒ String
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 ‘AUTO_MERGE` to update the merged API endpoint with the source API changes automatically.
4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 |
# File 'lib/aws-sdk-appsync/types.rb', line 4819 class UpdateGraphqlApiRequest < Struct.new( :api_id, :name, :log_config, :authentication_type, :user_pool_config, :open_id_connect_config, :additional_authentication_providers, :xray_enabled, :lambda_authorizer_config, :merged_api_execution_role_arn, :owner_contact, :introspection_config, :query_depth_limit, :resolver_count_limit, :enhanced_metrics_config) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The new name for the ‘GraphqlApi` object.
4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 |
# File 'lib/aws-sdk-appsync/types.rb', line 4819 class UpdateGraphqlApiRequest < Struct.new( :api_id, :name, :log_config, :authentication_type, :user_pool_config, :open_id_connect_config, :additional_authentication_providers, :xray_enabled, :lambda_authorizer_config, :merged_api_execution_role_arn, :owner_contact, :introspection_config, :query_depth_limit, :resolver_count_limit, :enhanced_metrics_config) SENSITIVE = [] include Aws::Structure end |
#open_id_connect_config ⇒ Types::OpenIDConnectConfig
The OpenID Connect configuration for the ‘GraphqlApi` object.
4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 |
# File 'lib/aws-sdk-appsync/types.rb', line 4819 class UpdateGraphqlApiRequest < Struct.new( :api_id, :name, :log_config, :authentication_type, :user_pool_config, :open_id_connect_config, :additional_authentication_providers, :xray_enabled, :lambda_authorizer_config, :merged_api_execution_role_arn, :owner_contact, :introspection_config, :query_depth_limit, :resolver_count_limit, :enhanced_metrics_config) SENSITIVE = [] include Aws::Structure end |
#owner_contact ⇒ String
The owner contact information for an API resource.
This field accepts any string input with a length of 0 - 256 characters.
4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 |
# File 'lib/aws-sdk-appsync/types.rb', line 4819 class UpdateGraphqlApiRequest < Struct.new( :api_id, :name, :log_config, :authentication_type, :user_pool_config, :open_id_connect_config, :additional_authentication_providers, :xray_enabled, :lambda_authorizer_config, :merged_api_execution_role_arn, :owner_contact, :introspection_config, :query_depth_limit, :resolver_count_limit, :enhanced_metrics_config) SENSITIVE = [] include Aws::Structure end |
#query_depth_limit ⇒ Integer
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 ‘0` (or unspecified), which indicates there’s no depth limit. If you set a limit, it can be between ‘1` and `75` nested levels. This field will produce a limit error if the operation falls out of bounds.
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.
4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 |
# File 'lib/aws-sdk-appsync/types.rb', line 4819 class UpdateGraphqlApiRequest < Struct.new( :api_id, :name, :log_config, :authentication_type, :user_pool_config, :open_id_connect_config, :additional_authentication_providers, :xray_enabled, :lambda_authorizer_config, :merged_api_execution_role_arn, :owner_contact, :introspection_config, :query_depth_limit, :resolver_count_limit, :enhanced_metrics_config) SENSITIVE = [] include Aws::Structure end |
#resolver_count_limit ⇒ Integer
The maximum number of resolvers that can be invoked in a single request. The default value is ‘0` (or unspecified), which will set the limit to `10000`. When specified, the limit value can be between `1` and `10000`. This field will produce a limit error if the operation falls out of bounds.
4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 |
# File 'lib/aws-sdk-appsync/types.rb', line 4819 class UpdateGraphqlApiRequest < Struct.new( :api_id, :name, :log_config, :authentication_type, :user_pool_config, :open_id_connect_config, :additional_authentication_providers, :xray_enabled, :lambda_authorizer_config, :merged_api_execution_role_arn, :owner_contact, :introspection_config, :query_depth_limit, :resolver_count_limit, :enhanced_metrics_config) SENSITIVE = [] include Aws::Structure end |
#user_pool_config ⇒ Types::UserPoolConfig
The new Amazon Cognito user pool configuration for the ‘~GraphqlApi` object.
4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 |
# File 'lib/aws-sdk-appsync/types.rb', line 4819 class UpdateGraphqlApiRequest < Struct.new( :api_id, :name, :log_config, :authentication_type, :user_pool_config, :open_id_connect_config, :additional_authentication_providers, :xray_enabled, :lambda_authorizer_config, :merged_api_execution_role_arn, :owner_contact, :introspection_config, :query_depth_limit, :resolver_count_limit, :enhanced_metrics_config) SENSITIVE = [] include Aws::Structure end |
#xray_enabled ⇒ Boolean
A flag indicating whether to use X-Ray tracing for the ‘GraphqlApi`.
4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 |
# File 'lib/aws-sdk-appsync/types.rb', line 4819 class UpdateGraphqlApiRequest < Struct.new( :api_id, :name, :log_config, :authentication_type, :user_pool_config, :open_id_connect_config, :additional_authentication_providers, :xray_enabled, :lambda_authorizer_config, :merged_api_execution_role_arn, :owner_contact, :introspection_config, :query_depth_limit, :resolver_count_limit, :enhanced_metrics_config) SENSITIVE = [] include Aws::Structure end |