software.amazon.awscdk.services.appsync

Class CfnApiCache

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.appsync.CfnApiCache

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:51.434Z")
public class CfnApiCache
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppSync::ApiCache`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnApiCache.Builder A fluent builder for CfnApiCache.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

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)

Method Summary

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.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnApiCache

protected CfnApiCache(software.amazon.jsii.JsiiObjectRef objRef)

CfnApiCache

protected CfnApiCache(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnApiCache

public CfnApiCache(Construct scope,
                   java.lang.String id,
                   CfnApiCacheProps props)

Create a new `AWS::AppSync::ApiCache`.

Parameters:

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.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getApiCachingBehavior

public java.lang.String getApiCachingBehavior()

Caching behavior.

• FULL_REQUEST_CACHING : All requests are fully cached.
• PER_RESOLVER_CACHING : Individual resolvers that you specify are cached.

setApiCachingBehavior

public void setApiCachingBehavior(java.lang.String value)

Caching behavior.

• FULL_REQUEST_CACHING : All requests are fully cached.
• PER_RESOLVER_CACHING : Individual resolvers that you specify are cached.

getApiId

public java.lang.String getApiId()

The GraphQL API ID.

setApiId

public void setApiId(java.lang.String value)

The GraphQL API ID.

getTtl

public java.lang.Number getTtl()

TTL in seconds for cache entries.

Valid values are 1–3,600 seconds.

setTtl

public void setTtl(java.lang.Number value)

TTL in seconds for cache entries.

Valid values are 1–3,600 seconds.

getType

public java.lang.String getType()

The cache instance type. Valid values are.

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

• T2_SMALL : A t2.small instance type.
• T2_MEDIUM : A t2.medium instance type.
• R4_LARGE : A r4.large instance type.
• R4_XLARGE : A r4.xlarge instance type.
• R4_2XLARGE : A r4.2xlarge instance type.
• R4_4XLARGE : A r4.4xlarge instance type.
• R4_8XLARGE : A r4.8xlarge instance type.

setType

public void setType(java.lang.String value)

The cache instance type. Valid values are.

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

• T2_SMALL : A t2.small instance type.
• T2_MEDIUM : A t2.medium instance type.
• R4_LARGE : A r4.large instance type.
• R4_XLARGE : A r4.xlarge instance type.
• R4_2XLARGE : A r4.2xlarge instance type.
• R4_4XLARGE : A r4.4xlarge instance type.
• R4_8XLARGE : A r4.8xlarge instance type.

getAtRestEncryptionEnabled

public java.lang.Object getAtRestEncryptionEnabled()

At-rest encryption flag for cache.

You cannot update this setting after creation.

setAtRestEncryptionEnabled

public void setAtRestEncryptionEnabled(java.lang.Boolean value)

At-rest encryption flag for cache.

You cannot update this setting after creation.

setAtRestEncryptionEnabled

public void setAtRestEncryptionEnabled(IResolvable value)

At-rest encryption flag for cache.

You cannot update this setting after creation.

getTransitEncryptionEnabled

public java.lang.Object getTransitEncryptionEnabled()

Transit encryption flag when connecting to cache.

You cannot update this setting after creation.

setTransitEncryptionEnabled

public void setTransitEncryptionEnabled(java.lang.Boolean value)

Transit encryption flag when connecting to cache.

You cannot update this setting after creation.

setTransitEncryptionEnabled

public void setTransitEncryptionEnabled(IResolvable value)

Transit encryption flag when connecting to cache.

You cannot update this setting after creation.