@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:51.434Z") public class CfnApiCache extends CfnResource implements IInspectable
The AWS::AppSync::ApiCache
resource represents the input of a CreateApiCache
operation.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.appsync.*; CfnApiCache cfnApiCache = CfnApiCache.Builder.create(this, "MyCfnApiCache") .apiCachingBehavior("apiCachingBehavior") .apiId("apiId") .ttl(123) .type("type") // the properties below are optional .atRestEncryptionEnabled(false) .transitEncryptionEnabled(false) .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnApiCache.Builder
A fluent builder for
CfnApiCache . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnApiCache(Construct scope,
java.lang.String id,
CfnApiCacheProps props)
Create a new `AWS::AppSync::ApiCache`.
|
protected |
CfnApiCache(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnApiCache(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getApiCachingBehavior()
Caching behavior.
|
java.lang.String |
getApiId()
The GraphQL API ID.
|
java.lang.Object |
getAtRestEncryptionEnabled()
At-rest encryption flag for cache.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getTransitEncryptionEnabled()
Transit encryption flag when connecting to cache.
|
java.lang.Number |
getTtl()
TTL in seconds for cache entries.
|
java.lang.String |
getType()
The cache instance type.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setApiCachingBehavior(java.lang.String value)
Caching behavior.
|
void |
setApiId(java.lang.String value)
The GraphQL API ID.
|
void |
setAtRestEncryptionEnabled(java.lang.Boolean value)
At-rest encryption flag for cache.
|
void |
setAtRestEncryptionEnabled(IResolvable value)
At-rest encryption flag for cache.
|
void |
setTransitEncryptionEnabled(java.lang.Boolean value)
Transit encryption flag when connecting to cache.
|
void |
setTransitEncryptionEnabled(IResolvable value)
Transit encryption flag when connecting to cache.
|
void |
setTtl(java.lang.Number value)
TTL in seconds for cache entries.
|
void |
setType(java.lang.String value)
The cache instance type.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnApiCache(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnApiCache(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnApiCache(Construct scope, java.lang.String id, CfnApiCacheProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getApiCachingBehavior()
public void setApiCachingBehavior(java.lang.String value)
public java.lang.String getApiId()
public void setApiId(java.lang.String value)
public java.lang.Number getTtl()
Valid values are 1–3,600 seconds.
public void setTtl(java.lang.Number value)
Valid values are 1–3,600 seconds.
public java.lang.String getType()
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:
public void setType(java.lang.String value)
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:
public java.lang.Object getAtRestEncryptionEnabled()
You cannot update this setting after creation.
public void setAtRestEncryptionEnabled(java.lang.Boolean value)
You cannot update this setting after creation.
public void setAtRestEncryptionEnabled(IResolvable value)
You cannot update this setting after creation.
public java.lang.Object getTransitEncryptionEnabled()
You cannot update this setting after creation.
public void setTransitEncryptionEnabled(java.lang.Boolean value)
You cannot update this setting after creation.
public void setTransitEncryptionEnabled(IResolvable value)
You cannot update this setting after creation.