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.UpdateApiCache

Description

Updates the cache for the GraphQL API.

Synopsis

Creating a Request

data UpdateApiCache Source #

Represents the input of a UpdateApiCache operation.

See: newUpdateApiCache smart constructor.

Constructors

UpdateApiCache' 

Fields

  • apiId :: Text

    The GraphQL API ID.

  • ttl :: Integer

    TTL in seconds for cache entries.

    Valid values are 1–3,600 seconds.

  • apiCachingBehavior :: ApiCachingBehavior

    Caching behavior.

    • FULL_REQUEST_CACHING: All requests are fully cached.
    • PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
  • type' :: 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
ToJSON UpdateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

ToHeaders UpdateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

ToPath UpdateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

ToQuery UpdateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

AWSRequest UpdateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

Associated Types

type AWSResponse UpdateApiCache #

Generic UpdateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

Associated Types

type Rep UpdateApiCache :: Type -> Type #

Read UpdateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

Show UpdateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

NFData UpdateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

Methods

rnf :: UpdateApiCache -> () #

Eq UpdateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

Hashable UpdateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

type AWSResponse UpdateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

type Rep UpdateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

type Rep UpdateApiCache = D1 ('MetaData "UpdateApiCache" "Amazonka.AppSync.UpdateApiCache" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "UpdateApiCache'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "apiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "ttl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer)) :*: (S1 ('MetaSel ('Just "apiCachingBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ApiCachingBehavior) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ApiCacheType))))

newUpdateApiCache Source #

Create a value of UpdateApiCache 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:

UpdateApiCache, updateApiCache_apiId - The GraphQL API ID.

UpdateApiCache, updateApiCache_ttl - TTL in seconds for cache entries.

Valid values are 1–3,600 seconds.

UpdateApiCache, updateApiCache_apiCachingBehavior - Caching behavior.

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

UpdateApiCache, updateApiCache_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.

Request Lenses

updateApiCache_ttl :: Lens' UpdateApiCache Integer Source #

TTL in seconds for cache entries.

Valid values are 1–3,600 seconds.

updateApiCache_apiCachingBehavior :: Lens' UpdateApiCache ApiCachingBehavior Source #

Caching behavior.

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

updateApiCache_type :: Lens' UpdateApiCache 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.

Destructuring the Response

data UpdateApiCacheResponse Source #

Represents the output of a UpdateApiCache operation.

See: newUpdateApiCacheResponse smart constructor.

Constructors

UpdateApiCacheResponse' 

Fields

Instances

Instances details
Generic UpdateApiCacheResponse Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

Associated Types

type Rep UpdateApiCacheResponse :: Type -> Type #

Read UpdateApiCacheResponse Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

Show UpdateApiCacheResponse Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

NFData UpdateApiCacheResponse Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

Methods

rnf :: UpdateApiCacheResponse -> () #

Eq UpdateApiCacheResponse Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

type Rep UpdateApiCacheResponse Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

type Rep UpdateApiCacheResponse = D1 ('MetaData "UpdateApiCacheResponse" "Amazonka.AppSync.UpdateApiCache" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "UpdateApiCacheResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "apiCache") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ApiCache)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateApiCacheResponse Source #

Create a value of UpdateApiCacheResponse 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:apiCache:UpdateApiCacheResponse', updateApiCacheResponse_apiCache - The ApiCache object.

$sel:httpStatus:UpdateApiCacheResponse', updateApiCacheResponse_httpStatus - The response's http status code.

Response Lenses