libZSservicesZSamazonka-appsyncZSamazonka-appsync
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.AppSync.CreateApiCache

Description

Creates a cache for the GraphQL API.

Synopsis

Creating a Request

data CreateApiCache Source #

Represents the input of a CreateApiCache operation.

See: newCreateApiCache smart constructor.

Constructors

CreateApiCache' 

Fields

  • atRestEncryptionEnabled :: Maybe Bool

    At rest encryption flag for cache. This setting cannot be updated after creation.

  • transitEncryptionEnabled :: Maybe Bool

    Transit encryption flag when connecting to cache. This setting cannot be updated after creation.

  • apiId :: Text

    The GraphQL API Id.

  • ttl :: Integer

    TTL in seconds for cache entries.

    Valid values are between 1 and 3600 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
Eq CreateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.CreateApiCache

Methods

(==) :: CreateApiCache -> CreateApiCache -> Bool #

(/=) :: CreateApiCache -> CreateApiCache -> Bool #

Read CreateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.CreateApiCache

Methods

readsPrec :: Int -> ReadS CreateApiCache #

readList :: ReadS [CreateApiCache] #

readPrec :: ReadPrec CreateApiCache #

readListPrec :: ReadPrec [CreateApiCache] #

Show CreateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.CreateApiCache

Methods

showsPrec :: Int -> CreateApiCache -> ShowS #

show :: CreateApiCache -> String #

showList :: [CreateApiCache] -> ShowS #

Generic CreateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.CreateApiCache

Associated Types

type Rep CreateApiCache :: Type -> Type #

Methods

from :: CreateApiCache -> Rep CreateApiCache x #

to :: Rep CreateApiCache x -> CreateApiCache #

NFData CreateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.CreateApiCache

Methods

rnf :: CreateApiCache -> () #

Hashable CreateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.CreateApiCache

Methods

hashWithSalt :: Int -> CreateApiCache -> Int #

hash :: CreateApiCache -> Int #

ToJSON CreateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.CreateApiCache

Methods

toJSON :: CreateApiCache -> Value #

toEncoding :: CreateApiCache -> Encoding #

toJSONList :: [CreateApiCache] -> Value #

toEncodingList :: [CreateApiCache] -> Encoding #

AWSRequest CreateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.CreateApiCache

Associated Types

type AWSResponse CreateApiCache #

Methods

request :: CreateApiCache -> Request CreateApiCache #

response :: MonadResource m => Logger -> Service -> Proxy CreateApiCache -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateApiCache))) #

ToHeaders CreateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.CreateApiCache

Methods

toHeaders :: CreateApiCache -> [Header] #

ToPath CreateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.CreateApiCache

Methods

toPath :: CreateApiCache -> ByteString #

ToQuery CreateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.CreateApiCache

Methods

toQuery :: CreateApiCache -> QueryString #

type Rep CreateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.CreateApiCache

type Rep CreateApiCache = D1 ('MetaData "CreateApiCache" "Amazonka.AppSync.CreateApiCache" "libZSservicesZSamazonka-appsyncZSamazonka-appsync" 'False) (C1 ('MetaCons "CreateApiCache'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "atRestEncryptionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "transitEncryptionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: 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)))))
type AWSResponse CreateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.CreateApiCache

type AWSResponse CreateApiCache = CreateApiCacheResponse

newCreateApiCache Source #

Arguments

:: Text

$sel:apiId:CreateApiCache'

-> Integer

$sel:ttl:CreateApiCache'

-> ApiCachingBehavior

$sel:apiCachingBehavior:CreateApiCache'

-> ApiCacheType

$sel:type':CreateApiCache'

-> CreateApiCache 

Create a value of CreateApiCache 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:atRestEncryptionEnabled:CreateApiCache', createApiCache_atRestEncryptionEnabled - At rest encryption flag for cache. This setting cannot be updated after creation.

$sel:transitEncryptionEnabled:CreateApiCache', createApiCache_transitEncryptionEnabled - Transit encryption flag when connecting to cache. This setting cannot be updated after creation.

$sel:apiId:CreateApiCache', createApiCache_apiId - The GraphQL API Id.

$sel:ttl:CreateApiCache', createApiCache_ttl - TTL in seconds for cache entries.

Valid values are between 1 and 3600 seconds.

$sel:apiCachingBehavior:CreateApiCache', createApiCache_apiCachingBehavior - Caching behavior.

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

$sel:type':CreateApiCache', createApiCache_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

createApiCache_atRestEncryptionEnabled :: Lens' CreateApiCache (Maybe Bool) Source #

At rest encryption flag for cache. This setting cannot be updated after creation.

createApiCache_transitEncryptionEnabled :: Lens' CreateApiCache (Maybe Bool) Source #

Transit encryption flag when connecting to cache. This setting cannot be updated after creation.

createApiCache_apiId :: Lens' CreateApiCache Text Source #

The GraphQL API Id.

createApiCache_ttl :: Lens' CreateApiCache Integer Source #

TTL in seconds for cache entries.

Valid values are between 1 and 3600 seconds.

createApiCache_apiCachingBehavior :: Lens' CreateApiCache ApiCachingBehavior Source #

Caching behavior.

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

createApiCache_type :: Lens' CreateApiCache 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 CreateApiCacheResponse Source #

Represents the output of a CreateApiCache operation.

See: newCreateApiCacheResponse smart constructor.

Constructors

CreateApiCacheResponse' 

Fields

Instances

Instances details
Eq CreateApiCacheResponse Source # 
Instance details

Defined in Amazonka.AppSync.CreateApiCache

Methods

(==) :: CreateApiCacheResponse -> CreateApiCacheResponse -> Bool #

(/=) :: CreateApiCacheResponse -> CreateApiCacheResponse -> Bool #

Read CreateApiCacheResponse Source # 
Instance details

Defined in Amazonka.AppSync.CreateApiCache

Methods

readsPrec :: Int -> ReadS CreateApiCacheResponse #

readList :: ReadS [CreateApiCacheResponse] #

readPrec :: ReadPrec CreateApiCacheResponse #

readListPrec :: ReadPrec [CreateApiCacheResponse] #

Show CreateApiCacheResponse Source # 
Instance details

Defined in Amazonka.AppSync.CreateApiCache

Methods

showsPrec :: Int -> CreateApiCacheResponse -> ShowS #

show :: CreateApiCacheResponse -> String #

showList :: [CreateApiCacheResponse] -> ShowS #

Generic CreateApiCacheResponse Source # 
Instance details

Defined in Amazonka.AppSync.CreateApiCache

Associated Types

type Rep CreateApiCacheResponse :: Type -> Type #

Methods

from :: CreateApiCacheResponse -> Rep CreateApiCacheResponse x #

to :: Rep CreateApiCacheResponse x -> CreateApiCacheResponse #

NFData CreateApiCacheResponse Source # 
Instance details

Defined in Amazonka.AppSync.CreateApiCache

Methods

rnf :: CreateApiCacheResponse -> () #

type Rep CreateApiCacheResponse Source # 
Instance details

Defined in Amazonka.AppSync.CreateApiCache

type Rep CreateApiCacheResponse = D1 ('MetaData "CreateApiCacheResponse" "Amazonka.AppSync.CreateApiCache" "libZSservicesZSamazonka-appsyncZSamazonka-appsync" 'False) (C1 ('MetaCons "CreateApiCacheResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "apiCache") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ApiCache)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateApiCacheResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateApiCacheResponse'

-> CreateApiCacheResponse 

Create a value of CreateApiCacheResponse 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:CreateApiCacheResponse', createApiCacheResponse_apiCache - The ApiCache object.

$sel:httpStatus:CreateApiCacheResponse', createApiCacheResponse_httpStatus - The response's http status code.

Response Lenses

createApiCacheResponse_apiCache :: Lens' CreateApiCacheResponse (Maybe ApiCache) Source #

The ApiCache object.

createApiCacheResponse_httpStatus :: Lens' CreateApiCacheResponse Int Source #

The response's http status code.