amazonka-appsync-2.0: Amazon AppSync SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.AppSync.Types.ApiCache

Description

 
Synopsis

Documentation

data ApiCache Source #

The ApiCache object.

See: newApiCache smart constructor.

Constructors

ApiCache' 

Fields

  • apiCachingBehavior :: Maybe ApiCachingBehavior

    Caching behavior.

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

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

  • status :: Maybe ApiCacheStatus

    The cache instance status.

    • AVAILABLE: The instance is available for use.
    • CREATING: The instance is currently creating.
    • DELETING: The instance is currently deleting.
    • MODIFYING: The instance is currently modifying.
    • FAILED: The instance has failed creation.
  • transitEncryptionEnabled :: Maybe Bool

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

  • ttl :: Maybe Integer

    TTL in seconds for cache entries.

    Valid values are 1–3,600 seconds.

  • type' :: Maybe ApiCacheType

    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.

Instances

Instances details
FromJSON ApiCache Source # 
Instance details

Defined in Amazonka.AppSync.Types.ApiCache

Generic ApiCache Source # 
Instance details

Defined in Amazonka.AppSync.Types.ApiCache

Associated Types

type Rep ApiCache :: Type -> Type #

Methods

from :: ApiCache -> Rep ApiCache x #

to :: Rep ApiCache x -> ApiCache #

Read ApiCache Source # 
Instance details

Defined in Amazonka.AppSync.Types.ApiCache

Show ApiCache Source # 
Instance details

Defined in Amazonka.AppSync.Types.ApiCache

NFData ApiCache Source # 
Instance details

Defined in Amazonka.AppSync.Types.ApiCache

Methods

rnf :: ApiCache -> () #

Eq ApiCache Source # 
Instance details

Defined in Amazonka.AppSync.Types.ApiCache

Hashable ApiCache Source # 
Instance details

Defined in Amazonka.AppSync.Types.ApiCache

Methods

hashWithSalt :: Int -> ApiCache -> Int #

hash :: ApiCache -> Int #

type Rep ApiCache Source # 
Instance details

Defined in Amazonka.AppSync.Types.ApiCache

type Rep ApiCache = D1 ('MetaData "ApiCache" "Amazonka.AppSync.Types.ApiCache" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "ApiCache'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "apiCachingBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ApiCachingBehavior)) :*: (S1 ('MetaSel ('Just "atRestEncryptionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ApiCacheStatus)))) :*: (S1 ('MetaSel ('Just "transitEncryptionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "ttl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ApiCacheType))))))

newApiCache :: ApiCache Source #

Create a value of ApiCache with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:apiCachingBehavior:ApiCache', apiCache_apiCachingBehavior - Caching behavior.

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

$sel:atRestEncryptionEnabled:ApiCache', apiCache_atRestEncryptionEnabled - At-rest encryption flag for cache. You cannot update this setting after creation.

$sel:status:ApiCache', apiCache_status - The cache instance status.

  • AVAILABLE: The instance is available for use.
  • CREATING: The instance is currently creating.
  • DELETING: The instance is currently deleting.
  • MODIFYING: The instance is currently modifying.
  • FAILED: The instance has failed creation.

$sel:transitEncryptionEnabled:ApiCache', apiCache_transitEncryptionEnabled - Transit encryption flag when connecting to cache. You cannot update this setting after creation.

$sel:ttl:ApiCache', apiCache_ttl - TTL in seconds for cache entries.

Valid values are 1–3,600 seconds.

$sel:type':ApiCache', apiCache_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.

apiCache_apiCachingBehavior :: Lens' ApiCache (Maybe ApiCachingBehavior) Source #

Caching behavior.

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

apiCache_atRestEncryptionEnabled :: Lens' ApiCache (Maybe Bool) Source #

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

apiCache_status :: Lens' ApiCache (Maybe ApiCacheStatus) Source #

The cache instance status.

  • AVAILABLE: The instance is available for use.
  • CREATING: The instance is currently creating.
  • DELETING: The instance is currently deleting.
  • MODIFYING: The instance is currently modifying.
  • FAILED: The instance has failed creation.

apiCache_transitEncryptionEnabled :: Lens' ApiCache (Maybe Bool) Source #

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

apiCache_ttl :: Lens' ApiCache (Maybe Integer) Source #

TTL in seconds for cache entries.

Valid values are 1–3,600 seconds.

apiCache_type :: Lens' ApiCache (Maybe ApiCacheType) Source #

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.