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

Class: Aws::AppSync::Types::UpdateGraphqlApiRequest

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 UpdateGraphqlApiRequest data as a hash:

{
  api_id: "String", # required
  name: "String", # required
  authentication_type: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS
  user_pool_config: {
    user_pool_id: "String", # required
    aws_region: "String", # required
    default_action: "ALLOW", # required, accepts ALLOW, DENY
    app_id_client_regex: "String",
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#api_idString

The API ID.

Returns:

  • (String)


1376
1377
1378
1379
1380
1381
1382
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1376

class UpdateGraphqlApiRequest < Struct.new(
  :api_id,
  :name,
  :authentication_type,
  :user_pool_config)
  include Aws::Structure
end

#authentication_typeString

The new authentication type for the GraphqlApi object.

Returns:

  • (String)


1376
1377
1378
1379
1380
1381
1382
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1376

class UpdateGraphqlApiRequest < Struct.new(
  :api_id,
  :name,
  :authentication_type,
  :user_pool_config)
  include Aws::Structure
end

#nameString

The new name for the GraphqlApi object.

Returns:

  • (String)


1376
1377
1378
1379
1380
1381
1382
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1376

class UpdateGraphqlApiRequest < Struct.new(
  :api_id,
  :name,
  :authentication_type,
  :user_pool_config)
  include Aws::Structure
end

#user_pool_configTypes::UserPoolConfig

The new Amazon Cognito User Pool configuration for the GraphqlApi object.



1376
1377
1378
1379
1380
1381
1382
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1376

class UpdateGraphqlApiRequest < Struct.new(
  :api_id,
  :name,
  :authentication_type,
  :user_pool_config)
  include Aws::Structure
end