Class: Aws::AppSync::Types::CreateApiCacheRequest

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

{
  api_id: "String", # required
  ttl: 1, # required
  transit_encryption_enabled: false,
  at_rest_encryption_enabled: false,
  api_caching_behavior: "FULL_REQUEST_CACHING", # required, accepts FULL_REQUEST_CACHING, PER_RESOLVER_CACHING
  type: "T2_SMALL", # required, accepts T2_SMALL, T2_MEDIUM, R4_LARGE, R4_XLARGE, R4_2XLARGE, R4_4XLARGE, R4_8XLARGE, SMALL, MEDIUM, LARGE, XLARGE, LARGE_2X, LARGE_4X, LARGE_8X, LARGE_12X
}

Represents the input of a CreateApiCache operation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#api_caching_behaviorString

Caching behavior.

  • FULL_REQUEST_CACHING: All requests are fully cached.

  • PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

Returns:

  • (String)


534
535
536
537
538
539
540
541
542
543
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 534

class CreateApiCacheRequest < Struct.new(
  :api_id,
  :ttl,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :api_caching_behavior,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#api_idString

The GraphQL API Id.

Returns:

  • (String)


534
535
536
537
538
539
540
541
542
543
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 534

class CreateApiCacheRequest < Struct.new(
  :api_id,
  :ttl,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :api_caching_behavior,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#at_rest_encryption_enabledBoolean

At rest encryption flag for cache. This setting cannot be updated after creation.

Returns:

  • (Boolean)


534
535
536
537
538
539
540
541
542
543
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 534

class CreateApiCacheRequest < Struct.new(
  :api_id,
  :ttl,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :api_caching_behavior,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#transit_encryption_enabledBoolean

Transit encryption flag when connecting to cache. This setting cannot be updated after creation.

Returns:

  • (Boolean)


534
535
536
537
538
539
540
541
542
543
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 534

class CreateApiCacheRequest < Struct.new(
  :api_id,
  :ttl,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :api_caching_behavior,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#ttlInteger

TTL in seconds for cache entries.

Valid values are between 1 and 3600 seconds.

Returns:

  • (Integer)


534
535
536
537
538
539
540
541
542
543
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 534

class CreateApiCacheRequest < Struct.new(
  :api_id,
  :ttl,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :api_caching_behavior,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The cache instance type. Valid values are

  • SMALL

  • MEDIUM

  • LARGE

  • XLARGE

  • LARGE_2X

  • LARGE_4X

  • LARGE_8X (not available in all regions)

  • LARGE_12X

Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

The following legacy instance types are available, but their use is discouraged:

  • T2_SMALL: A t2.small instance type.

  • T2_MEDIUM: A t2.medium instance type.

  • R4_LARGE: A r4.large instance type.

  • R4_XLARGE: A r4.xlarge instance type.

  • R4_2XLARGE: A r4.2xlarge instance type.

  • R4_4XLARGE: A r4.4xlarge instance type.

  • R4_8XLARGE: A r4.8xlarge instance type.

Returns:

  • (String)


534
535
536
537
538
539
540
541
542
543
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 534

class CreateApiCacheRequest < Struct.new(
  :api_id,
  :ttl,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :api_caching_behavior,
  :type)
  SENSITIVE = []
  include Aws::Structure
end