Class: Aws::AppSync::Types::CreateGraphqlApiRequest

Inherits:

Struct

Object
Struct
Aws::AppSync::Types::CreateGraphqlApiRequest

show all

Defined in:: gems/aws-sdk-appsync/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_type ⇒ String
The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).
#authentication_type ⇒ String
The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
#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.
#merged_api_execution_role_arn ⇒ String
The Identity and Access Management service role ARN for a merged API.
#name ⇒ String
A user-supplied name for the GraphqlApi.
#open_id_connect_config ⇒ Types::OpenIDConnectConfig
The OIDC configuration.
#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.
#tags ⇒ Hash<String,String>
A TagMap object.
#user_pool_config ⇒ Types::UserPoolConfig
The Amazon Cognito user pool configuration.
#visibility ⇒ String
Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE).
#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.

Returns:

(Array<Types::AdditionalAuthenticationProvider>)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1501

class CreateGraphqlApiRequest < Struct.new(
  :name,
  :log_config,
  :authentication_type,
  :user_pool_config,
  :open_id_connect_config,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :lambda_authorizer_config,
  :api_type,
  :merged_api_execution_role_arn,
  :visibility,
  :owner_contact,
  :introspection_config,
  :query_depth_limit,
  :resolver_count_limit,
  :enhanced_metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#api_type ⇒ `String`

The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).

Returns:

(String)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1501

class CreateGraphqlApiRequest < Struct.new(
  :name,
  :log_config,
  :authentication_type,
  :user_pool_config,
  :open_id_connect_config,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :lambda_authorizer_config,
  :api_type,
  :merged_api_execution_role_arn,
  :visibility,
  :owner_contact,
  :introspection_config,
  :query_depth_limit,
  :resolver_count_limit,
  :enhanced_metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#authentication_type ⇒ `String`

The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

Returns:

(String)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1501

class CreateGraphqlApiRequest < Struct.new(
  :name,
  :log_config,
  :authentication_type,
  :user_pool_config,
  :open_id_connect_config,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :lambda_authorizer_config,
  :api_type,
  :merged_api_execution_role_arn,
  :visibility,
  :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.

Returns:

(Types::EnhancedMetricsConfig)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1501

class CreateGraphqlApiRequest < Struct.new(
  :name,
  :log_config,
  :authentication_type,
  :user_pool_config,
  :open_id_connect_config,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :lambda_authorizer_config,
  :api_type,
  :merged_api_execution_role_arn,
  :visibility,
  :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.

Returns:

(String)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1501

class CreateGraphqlApiRequest < Struct.new(
  :name,
  :log_config,
  :authentication_type,
  :user_pool_config,
  :open_id_connect_config,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :lambda_authorizer_config,
  :api_type,
  :merged_api_execution_role_arn,
  :visibility,
  :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.

Returns:

(Types::LambdaAuthorizerConfig)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1501

class CreateGraphqlApiRequest < Struct.new(
  :name,
  :log_config,
  :authentication_type,
  :user_pool_config,
  :open_id_connect_config,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :lambda_authorizer_config,
  :api_type,
  :merged_api_execution_role_arn,
  :visibility,
  :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.

Returns:

(Types::LogConfig)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1501

class CreateGraphqlApiRequest < Struct.new(
  :name,
  :log_config,
  :authentication_type,
  :user_pool_config,
  :open_id_connect_config,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :lambda_authorizer_config,
  :api_type,
  :merged_api_execution_role_arn,
  :visibility,
  :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.

Returns:

(String)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1501

class CreateGraphqlApiRequest < Struct.new(
  :name,
  :log_config,
  :authentication_type,
  :user_pool_config,
  :open_id_connect_config,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :lambda_authorizer_config,
  :api_type,
  :merged_api_execution_role_arn,
  :visibility,
  :owner_contact,
  :introspection_config,
  :query_depth_limit,
  :resolver_count_limit,
  :enhanced_metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

A user-supplied name for the GraphqlApi.

Returns:

(String)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1501

class CreateGraphqlApiRequest < Struct.new(
  :name,
  :log_config,
  :authentication_type,
  :user_pool_config,
  :open_id_connect_config,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :lambda_authorizer_config,
  :api_type,
  :merged_api_execution_role_arn,
  :visibility,
  :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 OIDC configuration.

Returns:

(Types::OpenIDConnectConfig)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1501

class CreateGraphqlApiRequest < Struct.new(
  :name,
  :log_config,
  :authentication_type,
  :user_pool_config,
  :open_id_connect_config,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :lambda_authorizer_config,
  :api_type,
  :merged_api_execution_role_arn,
  :visibility,
  :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.

Returns:

(String)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1501

class CreateGraphqlApiRequest < Struct.new(
  :name,
  :log_config,
  :authentication_type,
  :user_pool_config,
  :open_id_connect_config,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :lambda_authorizer_config,
  :api_type,
  :merged_api_execution_role_arn,
  :visibility,
  :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.

Returns:

(Integer)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1501

class CreateGraphqlApiRequest < Struct.new(
  :name,
  :log_config,
  :authentication_type,
  :user_pool_config,
  :open_id_connect_config,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :lambda_authorizer_config,
  :api_type,
  :merged_api_execution_role_arn,
  :visibility,
  :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.

Returns:

(Integer)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1501

class CreateGraphqlApiRequest < Struct.new(
  :name,
  :log_config,
  :authentication_type,
  :user_pool_config,
  :open_id_connect_config,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :lambda_authorizer_config,
  :api_type,
  :merged_api_execution_role_arn,
  :visibility,
  :owner_contact,
  :introspection_config,
  :query_depth_limit,
  :resolver_count_limit,
  :enhanced_metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Hash<String,String>`

A TagMap object.

Returns:

(Hash<String,String>)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1501

class CreateGraphqlApiRequest < Struct.new(
  :name,
  :log_config,
  :authentication_type,
  :user_pool_config,
  :open_id_connect_config,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :lambda_authorizer_config,
  :api_type,
  :merged_api_execution_role_arn,
  :visibility,
  :owner_contact,
  :introspection_config,
  :query_depth_limit,
  :resolver_count_limit,
  :enhanced_metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#user_pool_config ⇒ `Types::UserPoolConfig`

The Amazon Cognito user pool configuration.

Returns:

(Types::UserPoolConfig)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1501

class CreateGraphqlApiRequest < Struct.new(
  :name,
  :log_config,
  :authentication_type,
  :user_pool_config,
  :open_id_connect_config,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :lambda_authorizer_config,
  :api_type,
  :merged_api_execution_role_arn,
  :visibility,
  :owner_contact,
  :introspection_config,
  :query_depth_limit,
  :resolver_count_limit,
  :enhanced_metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#visibility ⇒ `String`

Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.

Returns:

(String)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1501

class CreateGraphqlApiRequest < Struct.new(
  :name,
  :log_config,
  :authentication_type,
  :user_pool_config,
  :open_id_connect_config,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :lambda_authorizer_config,
  :api_type,
  :merged_api_execution_role_arn,
  :visibility,
  :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.

Returns:

(Boolean)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1501

class CreateGraphqlApiRequest < Struct.new(
  :name,
  :log_config,
  :authentication_type,
  :user_pool_config,
  :open_id_connect_config,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :lambda_authorizer_config,
  :api_type,
  :merged_api_execution_role_arn,
  :visibility,
  :owner_contact,
  :introspection_config,
  :query_depth_limit,
  :resolver_count_limit,
  :enhanced_metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::AppSync::Types::CreateGraphqlApiRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#additional_authentication_providers ⇒ Array<Types::AdditionalAuthenticationProvider>

#api_type ⇒ String

#authentication_type ⇒ String

#enhanced_metrics_config ⇒ Types::EnhancedMetricsConfig

#introspection_config ⇒ String

#lambda_authorizer_config ⇒ Types::LambdaAuthorizerConfig

#log_config ⇒ Types::LogConfig

#merged_api_execution_role_arn ⇒ String

#name ⇒ String

#open_id_connect_config ⇒ Types::OpenIDConnectConfig

#owner_contact ⇒ String

#query_depth_limit ⇒ Integer

#resolver_count_limit ⇒ Integer

#tags ⇒ Hash<String,String>

#user_pool_config ⇒ Types::UserPoolConfig

#visibility ⇒ String

#xray_enabled ⇒ Boolean

#additional_authentication_providers ⇒ `Array<Types::AdditionalAuthenticationProvider>`

#api_type ⇒ `String`

#authentication_type ⇒ `String`

#enhanced_metrics_config ⇒ `Types::EnhancedMetricsConfig`

#introspection_config ⇒ `String`

#lambda_authorizer_config ⇒ `Types::LambdaAuthorizerConfig`

#log_config ⇒ `Types::LogConfig`

#merged_api_execution_role_arn ⇒ `String`

#name ⇒ `String`

#open_id_connect_config ⇒ `Types::OpenIDConnectConfig`

#owner_contact ⇒ `String`

#query_depth_limit ⇒ `Integer`

#resolver_count_limit ⇒ `Integer`

#tags ⇒ `Hash<String,String>`

#user_pool_config ⇒ `Types::UserPoolConfig`

#visibility ⇒ `String`

#xray_enabled ⇒ `Boolean`