You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb

Overview

Note:

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
  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
      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",
      },
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#additional_authentication_providersArray<Types::AdditionalAuthenticationProvider>

A list of additional authentication providers for the GraphqlApi API.



582
583
584
585
586
587
588
589
590
591
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 582

class CreateGraphqlApiRequest < Struct.new(
  :name,
  :log_config,
  :authentication_type,
  :user_pool_config,
  :open_id_connect_config,
  :tags,
  :additional_authentication_providers)
  include Aws::Structure
end

#authentication_typeString

The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.

Returns:

  • (String)


582
583
584
585
586
587
588
589
590
591
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 582

class CreateGraphqlApiRequest < Struct.new(
  :name,
  :log_config,
  :authentication_type,
  :user_pool_config,
  :open_id_connect_config,
  :tags,
  :additional_authentication_providers)
  include Aws::Structure
end

#log_configTypes::LogConfig

The Amazon CloudWatch Logs configuration.

Returns:



582
583
584
585
586
587
588
589
590
591
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 582

class CreateGraphqlApiRequest < Struct.new(
  :name,
  :log_config,
  :authentication_type,
  :user_pool_config,
  :open_id_connect_config,
  :tags,
  :additional_authentication_providers)
  include Aws::Structure
end

#nameString

A user-supplied name for the GraphqlApi.

Returns:

  • (String)


582
583
584
585
586
587
588
589
590
591
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 582

class CreateGraphqlApiRequest < Struct.new(
  :name,
  :log_config,
  :authentication_type,
  :user_pool_config,
  :open_id_connect_config,
  :tags,
  :additional_authentication_providers)
  include Aws::Structure
end

#open_id_connect_configTypes::OpenIDConnectConfig

The OpenID Connect configuration.



582
583
584
585
586
587
588
589
590
591
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 582

class CreateGraphqlApiRequest < Struct.new(
  :name,
  :log_config,
  :authentication_type,
  :user_pool_config,
  :open_id_connect_config,
  :tags,
  :additional_authentication_providers)
  include Aws::Structure
end

#tagsHash<String,String>

A TagMap object.

Returns:

  • (Hash<String,String>)


582
583
584
585
586
587
588
589
590
591
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 582

class CreateGraphqlApiRequest < Struct.new(
  :name,
  :log_config,
  :authentication_type,
  :user_pool_config,
  :open_id_connect_config,
  :tags,
  :additional_authentication_providers)
  include Aws::Structure
end

#user_pool_configTypes::UserPoolConfig

The Amazon Cognito user pool configuration.



582
583
584
585
586
587
588
589
590
591
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 582

class CreateGraphqlApiRequest < Struct.new(
  :name,
  :log_config,
  :authentication_type,
  :user_pool_config,
  :open_id_connect_config,
  :tags,
  :additional_authentication_providers)
  include Aws::Structure
end