1.204.0

interface CfnApiCacheProps

LanguageType name
.NETAmazon.CDK.AWS.AppSync.CfnApiCacheProps
Javasoftware.amazon.awscdk.services.appsync.CfnApiCacheProps
Pythonaws_cdk.aws_appsync.CfnApiCacheProps
TypeScript @aws-cdk/aws-appsync » CfnApiCacheProps

Properties for defining a CfnApiCache.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as appsync from '@aws-cdk/aws-appsync';
const cfnApiCacheProps: appsync.CfnApiCacheProps = {
  apiCachingBehavior: 'apiCachingBehavior',
  apiId: 'apiId',
  ttl: 123,
  type: 'type',

  // the properties below are optional
  atRestEncryptionEnabled: false,
  transitEncryptionEnabled: false,
};

Properties

NameTypeDescription
apiCachingBehaviorstringCaching behavior.
apiIdstringThe GraphQL API ID.
ttlnumberTTL in seconds for cache entries.
typestringThe cache instance type. Valid values are.
atRestEncryptionEnabled?boolean | IResolvableAt-rest encryption flag for cache.
transitEncryptionEnabled?boolean | IResolvableTransit encryption flag when connecting to cache.

apiCachingBehavior

Type: string

Caching behavior.

  • FULL_REQUEST_CACHING : All requests are fully cached.
  • PER_RESOLVER_CACHING : Individual resolvers that you specify are cached.

apiId

Type: string

The GraphQL API ID.

ttl

Type: number

TTL in seconds for cache entries.

Valid values are 1–3,600 seconds.

type

Type: string

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.

atRestEncryptionEnabled?

Type: boolean | IResolvable (optional)

At-rest encryption flag for cache.

You cannot update this setting after creation.

transitEncryptionEnabled?

Type: boolean | IResolvable (optional)

Transit encryption flag when connecting to cache.

You cannot update this setting after creation.

← PreviousNext →