Class: Aws::AppSync::Types::CreateGraphqlApiRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::AppSync::Types::CreateGraphqlApiRequest
- Defined in:
- gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb
Overview
When making an API call, you may pass CreateGraphqlApiRequest data as a hash:
{
name: "String", # required
log_config: {
field_log_level: "NONE", # required, accepts NONE, ERROR, ALL
cloud_watch_logs_role_arn: "String", # required
exclude_verbose_content: false,
},
authentication_type: "API_KEY", # required, accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA
user_pool_config: {
user_pool_id: "String", # required
aws_region: "String", # required
default_action: "ALLOW", # required, accepts ALLOW, DENY
app_id_client_regex: "String",
},
open_id_connect_config: {
issuer: "String", # required
client_id: "String",
iat_ttl: 1,
auth_ttl: 1,
},
tags: {
"TagKey" => "TagValue",
},
additional_authentication_providers: [
{
authentication_type: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA
open_id_connect_config: {
issuer: "String", # required
client_id: "String",
iat_ttl: 1,
auth_ttl: 1,
},
user_pool_config: {
user_pool_id: "String", # required
aws_region: "String", # required
app_id_client_regex: "String",
},
lambda_authorizer_config: {
authorizer_result_ttl_in_seconds: 1,
authorizer_uri: "String", # required
identity_validation_expression: "String",
},
},
],
xray_enabled: false,
lambda_authorizer_config: {
authorizer_result_ttl_in_seconds: 1,
authorizer_uri: "String", # required
identity_validation_expression: "String",
},
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#additional_authentication_providers ⇒ Array<Types::AdditionalAuthenticationProvider>
A list of additional authentication providers for the
GraphqlApi
API. -
#authentication_type ⇒ String
The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
-
#lambda_authorizer_config ⇒ Types::LambdaAuthorizerConfig
Configuration for Lambda function authorization.
-
#log_config ⇒ Types::LogConfig
The Amazon CloudWatch Logs configuration.
-
#name ⇒ String
A user-supplied name for the
GraphqlApi
. -
#open_id_connect_config ⇒ Types::OpenIDConnectConfig
The OIDC configuration.
-
#tags ⇒ Hash<String,String>
A
TagMap
object. -
#user_pool_config ⇒ Types::UserPoolConfig
The Amazon Cognito user pool configuration.
-
#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.
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1044 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) 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.
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1044 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) SENSITIVE = [] include Aws::Structure end |
#lambda_authorizer_config ⇒ Types::LambdaAuthorizerConfig
Configuration for Lambda function authorization.
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1044 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) SENSITIVE = [] include Aws::Structure end |
#log_config ⇒ Types::LogConfig
The Amazon CloudWatch Logs configuration.
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1044 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) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
A user-supplied name for the GraphqlApi
.
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1044 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) SENSITIVE = [] include Aws::Structure end |
#open_id_connect_config ⇒ Types::OpenIDConnectConfig
The OIDC configuration.
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1044 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) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Hash<String,String>
A TagMap
object.
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1044 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) SENSITIVE = [] include Aws::Structure end |
#user_pool_config ⇒ Types::UserPoolConfig
The Amazon Cognito user pool configuration.
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1044 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) SENSITIVE = [] include Aws::Structure end |
#xray_enabled ⇒ Boolean
A flag indicating whether to use X-Ray tracing for the GraphqlApi
.
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1044 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) SENSITIVE = [] include Aws::Structure end |