Class CfnApiCacheProps
Properties for defining a CfnApiCache
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.AppSync
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnApiCacheProps : Object, ICfnApiCacheProps
Syntax (vb)
Public Class CfnApiCacheProps
Inherits Object
Implements 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
Constructors
CfnApiCacheProps() |
Properties
ApiCachingBehavior | Caching behavior. |
ApiId | The GraphQL API ID. |
AtRestEncryptionEnabled | At-rest encryption flag for cache. |
HealthMetricsConfig | Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:. |
TransitEncryptionEnabled | Transit encryption flag when connecting to cache. |
Ttl | TTL in seconds for cache entries. |
Type | The cache instance type. Valid values are. |
Constructors
CfnApiCacheProps()
public CfnApiCacheProps()
Properties
ApiCachingBehavior
Caching behavior.
public string ApiCachingBehavior { get; set; }
Property Value
System.String
Remarks
ApiId
The GraphQL API ID.
public string ApiId { get; set; }
Property Value
System.String
Remarks
AtRestEncryptionEnabled
At-rest encryption flag for cache.
public object AtRestEncryptionEnabled { get; set; }
Property Value
System.Object
Remarks
You cannot update this setting after creation.
HealthMetricsConfig
Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:.
public string HealthMetricsConfig { get; set; }
Property Value
System.String
Remarks
Metrics will be recorded by API ID. You can set the value to ENABLED
or DISABLED
.
TransitEncryptionEnabled
Transit encryption flag when connecting to cache.
public object TransitEncryptionEnabled { get; set; }
Property Value
System.Object
Remarks
You cannot update this setting after creation.
Ttl
TTL in seconds for cache entries.
public double Ttl { get; set; }
Property Value
System.Double
Remarks
Valid values are 1–3,600 seconds.
Type
The cache instance type. Valid values are.
public string Type { get; set; }
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: