Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.XRay.PutEncryptionConfig

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the encryption configuration for X-Ray data.

Creating a Request

data PutEncryptionConfig Source #

See: newPutEncryptionConfig smart constructor.

Constructors

PutEncryptionConfig'

Fields

keyId :: Maybe Text
An Amazon Web Services KMS key in one of the following formats:
- Alias - The name of the key. For example, alias/MyKey.
- Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Amazon Web Services X-Ray does not support asymmetric KMS keys.
- ARN - The full Amazon Resource Name of the key ID or alias. For example, arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to specify a key in a different account.
Omit this key if you set Type to NONE.
type' :: EncryptionType
The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for default encryption.

Instances

Instances details

ToJSON PutEncryptionConfig Source #
Instance details Defined in Amazonka.XRay.PutEncryptionConfig Methods toJSON :: PutEncryptionConfig -> Value # toEncoding :: PutEncryptionConfig -> Encoding # toJSONList :: [PutEncryptionConfig] -> Value # toEncodingList :: [PutEncryptionConfig] -> Encoding #
ToHeaders PutEncryptionConfig Source #
Instance details Defined in Amazonka.XRay.PutEncryptionConfig Methods toHeaders :: PutEncryptionConfig -> [Header] #
ToPath PutEncryptionConfig Source #
Instance details Defined in Amazonka.XRay.PutEncryptionConfig Methods toPath :: PutEncryptionConfig -> ByteString #
ToQuery PutEncryptionConfig Source #
Instance details Defined in Amazonka.XRay.PutEncryptionConfig Methods toQuery :: PutEncryptionConfig -> QueryString #
AWSRequest PutEncryptionConfig Source #
Instance details Defined in Amazonka.XRay.PutEncryptionConfig Associated Types type AWSResponse PutEncryptionConfig # Methods request :: (Service -> Service) -> PutEncryptionConfig -> Request PutEncryptionConfig # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutEncryptionConfig -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutEncryptionConfig))) #
Generic PutEncryptionConfig Source #
Instance details Defined in Amazonka.XRay.PutEncryptionConfig Associated Types type Rep PutEncryptionConfig :: Type -> Type # Methods from :: PutEncryptionConfig -> Rep PutEncryptionConfig x # to :: Rep PutEncryptionConfig x -> PutEncryptionConfig #
Read PutEncryptionConfig Source #
Instance details Defined in Amazonka.XRay.PutEncryptionConfig Methods readsPrec :: Int -> ReadS PutEncryptionConfig # readList :: ReadS [PutEncryptionConfig] # readPrec :: ReadPrec PutEncryptionConfig # readListPrec :: ReadPrec [PutEncryptionConfig] #
Show PutEncryptionConfig Source #
Instance details Defined in Amazonka.XRay.PutEncryptionConfig Methods showsPrec :: Int -> PutEncryptionConfig -> ShowS # show :: PutEncryptionConfig -> String # showList :: [PutEncryptionConfig] -> ShowS #
NFData PutEncryptionConfig Source #
Instance details Defined in Amazonka.XRay.PutEncryptionConfig Methods rnf :: PutEncryptionConfig -> () #
Eq PutEncryptionConfig Source #
Instance details Defined in Amazonka.XRay.PutEncryptionConfig Methods (==) :: PutEncryptionConfig -> PutEncryptionConfig -> Bool # (/=) :: PutEncryptionConfig -> PutEncryptionConfig -> Bool #
Hashable PutEncryptionConfig Source #
Instance details Defined in Amazonka.XRay.PutEncryptionConfig Methods hashWithSalt :: Int -> PutEncryptionConfig -> Int # hash :: PutEncryptionConfig -> Int #
type AWSResponse PutEncryptionConfig Source #
Instance details Defined in Amazonka.XRay.PutEncryptionConfig type AWSResponse PutEncryptionConfig = PutEncryptionConfigResponse
type Rep PutEncryptionConfig Source #
Instance details Defined in Amazonka.XRay.PutEncryptionConfig type Rep PutEncryptionConfig = D1 ('MetaData "PutEncryptionConfig" "Amazonka.XRay.PutEncryptionConfig" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "PutEncryptionConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EncryptionType)))

newPutEncryptionConfig Source #

Arguments

:: EncryptionType	`PutEncryptionConfig`
-> PutEncryptionConfig

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

PutEncryptionConfig, putEncryptionConfig_keyId - An Amazon Web Services KMS key in one of the following formats:

Alias - The name of the key. For example, alias/MyKey.
Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Amazon Web Services X-Ray does not support asymmetric KMS keys.
ARN - The full Amazon Resource Name of the key ID or alias. For example, arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to specify a key in a different account.

Omit this key if you set Type to NONE.

PutEncryptionConfig, putEncryptionConfig_type - The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for default encryption.

Request Lenses

putEncryptionConfig_keyId :: Lens' PutEncryptionConfig (Maybe Text) Source #

An Amazon Web Services KMS key in one of the following formats:

Alias - The name of the key. For example, alias/MyKey.
Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Amazon Web Services X-Ray does not support asymmetric KMS keys.
ARN - The full Amazon Resource Name of the key ID or alias. For example, arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to specify a key in a different account.

Omit this key if you set Type to NONE.

putEncryptionConfig_type :: Lens' PutEncryptionConfig EncryptionType Source #

The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for default encryption.

Destructuring the Response

data PutEncryptionConfigResponse Source #

See: newPutEncryptionConfigResponse smart constructor.

Constructors

PutEncryptionConfigResponse'
Fields encryptionConfig :: Maybe EncryptionConfig The new encryption configuration. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic PutEncryptionConfigResponse Source #
Instance details Defined in Amazonka.XRay.PutEncryptionConfig Associated Types type Rep PutEncryptionConfigResponse :: Type -> Type # Methods from :: PutEncryptionConfigResponse -> Rep PutEncryptionConfigResponse x # to :: Rep PutEncryptionConfigResponse x -> PutEncryptionConfigResponse #
Read PutEncryptionConfigResponse Source #
Instance details Defined in Amazonka.XRay.PutEncryptionConfig Methods readsPrec :: Int -> ReadS PutEncryptionConfigResponse # readList :: ReadS [PutEncryptionConfigResponse] # readPrec :: ReadPrec PutEncryptionConfigResponse # readListPrec :: ReadPrec [PutEncryptionConfigResponse] #
Show PutEncryptionConfigResponse Source #
Instance details Defined in Amazonka.XRay.PutEncryptionConfig Methods showsPrec :: Int -> PutEncryptionConfigResponse -> ShowS # show :: PutEncryptionConfigResponse -> String # showList :: [PutEncryptionConfigResponse] -> ShowS #
NFData PutEncryptionConfigResponse Source #
Instance details Defined in Amazonka.XRay.PutEncryptionConfig Methods rnf :: PutEncryptionConfigResponse -> () #
Eq PutEncryptionConfigResponse Source #
Instance details Defined in Amazonka.XRay.PutEncryptionConfig Methods (==) :: PutEncryptionConfigResponse -> PutEncryptionConfigResponse -> Bool # (/=) :: PutEncryptionConfigResponse -> PutEncryptionConfigResponse -> Bool #
type Rep PutEncryptionConfigResponse Source #
Instance details Defined in Amazonka.XRay.PutEncryptionConfig type Rep PutEncryptionConfigResponse = D1 ('MetaData "PutEncryptionConfigResponse" "Amazonka.XRay.PutEncryptionConfig" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "PutEncryptionConfigResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "encryptionConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionConfig)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutEncryptionConfigResponse Source #

Arguments

:: Int	`PutEncryptionConfigResponse`
-> PutEncryptionConfigResponse

Create a value of PutEncryptionConfigResponse 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:encryptionConfig:PutEncryptionConfigResponse', putEncryptionConfigResponse_encryptionConfig - The new encryption configuration.

PutEncryptionConfigResponse, putEncryptionConfigResponse_httpStatus - The response's http status code.

Response Lenses

putEncryptionConfigResponse_encryptionConfig :: Lens' PutEncryptionConfigResponse (Maybe EncryptionConfig) Source #

The new encryption configuration.

putEncryptionConfigResponse_httpStatus :: Lens' PutEncryptionConfigResponse Int Source #

The response's http status code.