Interface ICfnApiCacheProps

Properties for defining a CfnApiCache.

Namespace: Amazon.CDK.AWS.AppSync

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnApiCacheProps

Syntax (vb)

Public Interface ICfnApiCacheProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.AppSync;

             var cfnApiCacheProps = new CfnApiCacheProps {
                 ApiCachingBehavior = "apiCachingBehavior",
                 ApiId = "apiId",
                 Ttl = 123,
                 Type = "type",

                 // the properties below are optional
                 AtRestEncryptionEnabled = false,
                 HealthMetricsConfig = "healthMetricsConfig",
                 TransitEncryptionEnabled = false
             };

Synopsis

Properties

ApiCachingBehavior	Caching behavior.
ApiId	The GraphQL API ID.
AtRestEncryptionEnabled	This parameter has been deprecated .
HealthMetricsConfig	Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:.
TransitEncryptionEnabled	This parameter has been deprecated .
Ttl	TTL in seconds for cache entries.
Type	The cache instance type. Valid values are.

Properties

ApiCachingBehavior

Caching behavior.

string ApiCachingBehavior { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-apicachingbehavior

ApiId

The GraphQL API ID.

string ApiId { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-apiid

AtRestEncryptionEnabled

This parameter has been deprecated .

object? AtRestEncryptionEnabled { get; }

Property Value

object

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-atrestencryptionenabled

Type union: either bool or IResolvable

HealthMetricsConfig

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

string? HealthMetricsConfig { get; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-healthmetricsconfig

TransitEncryptionEnabled

This parameter has been deprecated .

object? TransitEncryptionEnabled { get; }

Property Value

object

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-transitencryptionenabled

Type union: either bool or IResolvable

Ttl

TTL in seconds for cache entries.

double Ttl { get; }

Property Value

double

Remarks

Valid values are 1–3,600 seconds.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-ttl

Type

The cache instance type. Valid values are.

string Type { get; }

Property Value

string

Remarks

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:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-type