Class CfnApiCache
The AWS::AppSync::ApiCache
resource represents the input of a CreateApiCache
operation.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.AppSync
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnApiCache : CfnResource, IInspectable
Syntax (vb)
Public Class CfnApiCache
Inherits CfnResource
Implements IInspectable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html
CloudformationResource: AWS::AppSync::ApiCache
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 cfnApiCache = new CfnApiCache(this, "MyCfnApiCache", new CfnApiCacheProps {
ApiCachingBehavior = "apiCachingBehavior",
ApiId = "apiId",
Ttl = 123,
Type = "type",
// the properties below are optional
AtRestEncryptionEnabled = false,
HealthMetricsConfig = "healthMetricsConfig",
TransitEncryptionEnabled = false
});
Synopsis
Constructors
CfnApiCache(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnApiCache(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnApiCache(Construct, String, ICfnApiCacheProps) |
Properties
ApiCachingBehavior | Caching behavior. |
ApiId | The GraphQL API ID. |
AtRestEncryptionEnabled | At-rest encryption flag for cache. |
AttrId | |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
HealthMetricsConfig | Controls how cache health metrics will be emitted to CloudWatch. |
TransitEncryptionEnabled | Transit encryption flag when connecting to cache. |
Ttl | TTL in seconds for cache entries. |
Type | The cache instance type. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnApiCache(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnApiCache(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnApiCache(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnApiCache(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnApiCache(Construct, String, ICfnApiCacheProps)
public CfnApiCache(Construct scope, string id, ICfnApiCacheProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnApiCacheProps
Resource properties.
Properties
ApiCachingBehavior
Caching behavior.
public virtual string ApiCachingBehavior { get; set; }
Property Value
System.String
ApiId
The GraphQL API ID.
public virtual string ApiId { get; set; }
Property Value
System.String
AtRestEncryptionEnabled
At-rest encryption flag for cache.
public virtual object AtRestEncryptionEnabled { get; set; }
Property Value
System.Object
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
HealthMetricsConfig
Controls how cache health metrics will be emitted to CloudWatch.
public virtual string HealthMetricsConfig { get; set; }
Property Value
System.String
Remarks
Cache health metrics include:.
TransitEncryptionEnabled
Transit encryption flag when connecting to cache.
public virtual object TransitEncryptionEnabled { get; set; }
Property Value
System.Object
Ttl
TTL in seconds for cache entries.
public virtual double Ttl { get; set; }
Property Value
System.Double
Type
The cache instance type.
public virtual string Type { get; set; }
Property Value
System.String
Remarks
Valid values are.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>