Package software.amazon.awscdk.cfnpropertymixins.services.appsync

Class CfnApiCachePropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.appsync.CfnApiCachePropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnApiCachePropsMixin>

Enclosing class:

CfnApiCachePropsMixin

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

A fluent builder for CfnApiCachePropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnApiCachePropsMixin.Builder	apiCachingBehavior(String apiCachingBehavior)	Caching behavior.
CfnApiCachePropsMixin.Builder	apiId(String apiId)	The GraphQL API ID.
CfnApiCachePropsMixin.Builder	atRestEncryptionEnabled(Boolean atRestEncryptionEnabled)	This parameter has been deprecated .
CfnApiCachePropsMixin.Builder	atRestEncryptionEnabled(IResolvable atRestEncryptionEnabled)	This parameter has been deprecated .
CfnApiCachePropsMixin	build()
static CfnApiCachePropsMixin.Builder	create()
static CfnApiCachePropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnApiCachePropsMixin.Builder	healthMetricsConfig(String healthMetricsConfig)	Controls how cache health metrics will be emitted to CloudWatch.
CfnApiCachePropsMixin.Builder	transitEncryptionEnabled(Boolean transitEncryptionEnabled)	This parameter has been deprecated .
CfnApiCachePropsMixin.Builder	transitEncryptionEnabled(IResolvable transitEncryptionEnabled)	This parameter has been deprecated .
CfnApiCachePropsMixin.Builder	ttl(Number ttl)	TTL in seconds for cache entries.
CfnApiCachePropsMixin.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 Details

create

@Stability(Stable)
public static CfnApiCachePropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnApiCachePropsMixin.Builder.

create

@Stability(Stable)
public static CfnApiCachePropsMixin.Builder create()

Returns:

a new instance of CfnApiCachePropsMixin.Builder.

apiCachingBehavior

@Stability(Stable)
public CfnApiCachePropsMixin.Builder apiCachingBehavior(String apiCachingBehavior)

Caching behavior.

• FULL_REQUEST_CACHING : All requests from the same user are cached. Individual resolvers are automatically cached. All API calls will try to return responses from the cache.
• PER_RESOLVER_CACHING : Individual resolvers that you specify are cached.
• OPERATION_LEVEL_CACHING : Full requests are cached together and returned without executing resolvers.

Parameters:

apiCachingBehavior - Caching behavior. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-apicachingbehavior

apiId

@Stability(Stable)
public CfnApiCachePropsMixin.Builder apiId(String apiId)

The GraphQL API ID.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-apiid

atRestEncryptionEnabled

@Stability(Stable)
public CfnApiCachePropsMixin.Builder atRestEncryptionEnabled(Boolean atRestEncryptionEnabled)

This parameter has been deprecated .

At-rest encryption flag for cache. You cannot update this setting after creation.

Parameters:

atRestEncryptionEnabled - This parameter has been deprecated . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-atrestencryptionenabled

atRestEncryptionEnabled

@Stability(Stable)
public CfnApiCachePropsMixin.Builder atRestEncryptionEnabled(IResolvable atRestEncryptionEnabled)

This parameter has been deprecated .

At-rest encryption flag for cache. You cannot update this setting after creation.

Parameters:

atRestEncryptionEnabled - This parameter has been deprecated . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-atrestencryptionenabled

healthMetricsConfig

@Stability(Stable)
public CfnApiCachePropsMixin.Builder healthMetricsConfig(String healthMetricsConfig)

Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:.

• NetworkBandwidthOutAllowanceExceeded : The network packets dropped because the throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache configuration.
• EngineCPUUtilization : The CPU utilization (percentage) allocated to the Redis process. This is useful for diagnosing bottlenecks in a cache configuration.

Metrics will be recorded by API ID. You can set the value to ENABLED or DISABLED .

Parameters:

healthMetricsConfig - Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-healthmetricsconfig

transitEncryptionEnabled

@Stability(Stable)
public CfnApiCachePropsMixin.Builder transitEncryptionEnabled(Boolean transitEncryptionEnabled)

This parameter has been deprecated .

Transit encryption flag when connecting to cache. You cannot update this setting after creation.

Parameters:

transitEncryptionEnabled - This parameter has been deprecated . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-transitencryptionenabled

transitEncryptionEnabled

@Stability(Stable)
public CfnApiCachePropsMixin.Builder transitEncryptionEnabled(IResolvable transitEncryptionEnabled)

This parameter has been deprecated .

Transit encryption flag when connecting to cache. You cannot update this setting after creation.

Parameters:

transitEncryptionEnabled - This parameter has been deprecated . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-transitencryptionenabled

ttl

@Stability(Stable)
public CfnApiCachePropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-ttl

type

@Stability(Stable)
public CfnApiCachePropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-type

build

@Stability(Stable)
public CfnApiCachePropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnApiCachePropsMixin.