software.amazon.awscdk.services.appsync

Class CfnApiCache.Builder

java.lang.Object

software.amazon.awscdk.services.appsync.CfnApiCache.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnApiCache>

Enclosing class:

CfnApiCache

@Stability(value=Stable)
public static final class CfnApiCache.Builder
extends Object
implements software.amazon.jsii.Builder<CfnApiCache>

A fluent builder for CfnApiCache.

Method Summary

Modifier and Type	Method and Description
CfnApiCache.Builder	apiCachingBehavior(String apiCachingBehavior) Caching behavior.
CfnApiCache.Builder	apiId(String apiId) The GraphQL API ID.
CfnApiCache.Builder	atRestEncryptionEnabled(Boolean atRestEncryptionEnabled) At-rest encryption flag for cache.
CfnApiCache.Builder	atRestEncryptionEnabled(IResolvable atRestEncryptionEnabled) At-rest encryption flag for cache.
CfnApiCache	build()
static CfnApiCache.Builder	create(software.constructs.Construct scope, String id)
CfnApiCache.Builder	transitEncryptionEnabled(Boolean transitEncryptionEnabled) Transit encryption flag when connecting to cache.
CfnApiCache.Builder	transitEncryptionEnabled(IResolvable transitEncryptionEnabled) Transit encryption flag when connecting to cache.
CfnApiCache.Builder	ttl(Number ttl) TTL in seconds for cache entries.
CfnApiCache.Builder	type(String type) The cache instance type.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static CfnApiCache.Builder create(software.constructs.Construct scope,
                                                                  String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnApiCache.Builder.

apiCachingBehavior

@Stability(value=Stable)
public CfnApiCache.Builder apiCachingBehavior(String apiCachingBehavior)

Caching behavior.

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

Parameters:

apiCachingBehavior - Caching behavior. This parameter is required.

Returns:

this

apiId

@Stability(value=Stable)
public CfnApiCache.Builder apiId(String apiId)

The GraphQL API ID.

Parameters:

apiId - The GraphQL API ID. This parameter is required.

Returns:

this

ttl

@Stability(value=Stable)
public CfnApiCache.Builder ttl(Number ttl)

TTL in seconds for cache entries.

Valid values are 1–3,600 seconds.

Parameters:

ttl - TTL in seconds for cache entries. This parameter is required.

Returns:

this

type

@Stability(value=Stable)
public CfnApiCache.Builder type(String type)

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.

Parameters:

type - The cache instance type. Valid values are. This parameter is required.

Returns:

this

atRestEncryptionEnabled

@Stability(value=Stable)
public CfnApiCache.Builder atRestEncryptionEnabled(Boolean atRestEncryptionEnabled)

At-rest encryption flag for cache.

You cannot update this setting after creation.

Parameters:

atRestEncryptionEnabled - At-rest encryption flag for cache. This parameter is required.

Returns:

this

atRestEncryptionEnabled

@Stability(value=Stable)
public CfnApiCache.Builder atRestEncryptionEnabled(IResolvable atRestEncryptionEnabled)

At-rest encryption flag for cache.

You cannot update this setting after creation.

Parameters:

atRestEncryptionEnabled - At-rest encryption flag for cache. This parameter is required.

Returns:

this

transitEncryptionEnabled

@Stability(value=Stable)
public CfnApiCache.Builder transitEncryptionEnabled(Boolean transitEncryptionEnabled)

Transit encryption flag when connecting to cache.

You cannot update this setting after creation.

Parameters:

transitEncryptionEnabled - Transit encryption flag when connecting to cache. This parameter is required.

Returns:

this

transitEncryptionEnabled

@Stability(value=Stable)
public CfnApiCache.Builder transitEncryptionEnabled(IResolvable transitEncryptionEnabled)

Transit encryption flag when connecting to cache.

You cannot update this setting after creation.

Parameters:

transitEncryptionEnabled - Transit encryption flag when connecting to cache. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnApiCache build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnApiCache>