AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateApiCache operation. Creates a cache for the GraphQL API.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.AppSync.AmazonAppSyncRequest
      Amazon.AppSync.Model.CreateApiCacheRequest

Namespace: Amazon.AppSync.Model
Assembly: AWSSDK.AppSync.dll
Version: 3.x.y.z

Syntax

C#
public class CreateApiCacheRequest : AmazonAppSyncRequest
         IAmazonWebServiceRequest

The CreateApiCacheRequest type exposes the following members

Constructors

NameDescription
Public Method CreateApiCacheRequest()

Properties

NameTypeDescription
Public Property ApiCachingBehavior Amazon.AppSync.ApiCachingBehavior

Gets and sets the property ApiCachingBehavior.

Caching behavior.

  • FULL_REQUEST_CACHING: All requests are fully cached.

  • PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

Public Property ApiId System.String

Gets and sets the property ApiId.

The GraphQL API ID.

Public Property AtRestEncryptionEnabled System.Boolean

Gets and sets the property AtRestEncryptionEnabled.

At-rest encryption flag for cache. You cannot update this setting after creation.

Public Property HealthMetricsConfig Amazon.AppSync.CacheHealthMetricsConfig

Gets and sets the property HealthMetricsConfig.

Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:

  • NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache configuration.

  • EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is useful for diagnosing bottlenecks in a cache configuration.

Metrics will be recorded by API ID. You can set the value to ENABLED or DISABLED.

Public Property TransitEncryptionEnabled System.Boolean

Gets and sets the property TransitEncryptionEnabled.

Transit encryption flag when connecting to cache. You cannot update this setting after creation.

Public Property Ttl System.Int64

Gets and sets the property Ttl.

TTL in seconds for cache entries.

Valid values are 1–3,600 seconds.

Public Property Type Amazon.AppSync.ApiCacheType

Gets and sets the property Type.

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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5