Interface ICfnApiCacheProps

Properties for defining a CfnApiCache.

Namespace: Amazon.CDK.AWS.AppSync

Assembly: Amazon.CDK.AWS.AppSync.dll

Syntax (csharp)

public interface ICfnApiCacheProps

Syntax (vb)

Public Interface ICfnApiCacheProps

Remarks

Link: 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,
    TransitEncryptionEnabled = false
};

Synopsis

Properties

ApiCachingBehavior	Caching behavior.
ApiId	The GraphQL API ID.
AtRestEncryptionEnabled	At-rest encryption flag for cache.
TransitEncryptionEnabled	Transit encryption flag when connecting to cache.
Ttl	TTL in seconds for cache entries.
Type	The cache instance type. Valid values are.

Properties

ApiCachingBehavior

Caching behavior.

string ApiCachingBehavior { get; }

Property Value

System.String

Remarks

Link: 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

System.String

Remarks

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

AtRestEncryptionEnabled

At-rest encryption flag for cache.

virtual object AtRestEncryptionEnabled { get; }

Property Value

System.Object

Remarks

You cannot update this setting after creation.

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

TransitEncryptionEnabled

Transit encryption flag when connecting to cache.

virtual object TransitEncryptionEnabled { get; }

Property Value

System.Object

Remarks

You cannot update this setting after creation.

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

Ttl

TTL in seconds for cache entries.

double Ttl { get; }

Property Value

System.Double

Remarks

Valid values are 1–3,600 seconds.

Link: 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

System.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:

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