amazonka-xray-2.0: Amazon X-Ray 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.XRay.PutEncryptionConfig

Description

Updates the encryption configuration for X-Ray data.

Synopsis

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

ToHeaders PutEncryptionConfig Source # 
Instance details

Defined in Amazonka.XRay.PutEncryptionConfig

ToPath PutEncryptionConfig Source # 
Instance details

Defined in Amazonka.XRay.PutEncryptionConfig

ToQuery PutEncryptionConfig Source # 
Instance details

Defined in Amazonka.XRay.PutEncryptionConfig

AWSRequest PutEncryptionConfig Source # 
Instance details

Defined in Amazonka.XRay.PutEncryptionConfig

Associated Types

type AWSResponse PutEncryptionConfig #

Generic PutEncryptionConfig Source # 
Instance details

Defined in Amazonka.XRay.PutEncryptionConfig

Associated Types

type Rep PutEncryptionConfig :: Type -> Type #

Read PutEncryptionConfig Source # 
Instance details

Defined in Amazonka.XRay.PutEncryptionConfig

Show PutEncryptionConfig Source # 
Instance details

Defined in Amazonka.XRay.PutEncryptionConfig

NFData PutEncryptionConfig Source # 
Instance details

Defined in Amazonka.XRay.PutEncryptionConfig

Methods

rnf :: PutEncryptionConfig -> () #

Eq PutEncryptionConfig Source # 
Instance details

Defined in Amazonka.XRay.PutEncryptionConfig

Hashable PutEncryptionConfig Source # 
Instance details

Defined in Amazonka.XRay.PutEncryptionConfig

type AWSResponse PutEncryptionConfig Source # 
Instance details

Defined in Amazonka.XRay.PutEncryptionConfig

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 #

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

Instances

Instances details
Generic PutEncryptionConfigResponse Source # 
Instance details

Defined in Amazonka.XRay.PutEncryptionConfig

Associated Types

type Rep PutEncryptionConfigResponse :: Type -> Type #

Read PutEncryptionConfigResponse Source # 
Instance details

Defined in Amazonka.XRay.PutEncryptionConfig

Show PutEncryptionConfigResponse Source # 
Instance details

Defined in Amazonka.XRay.PutEncryptionConfig

NFData PutEncryptionConfigResponse Source # 
Instance details

Defined in Amazonka.XRay.PutEncryptionConfig

Eq PutEncryptionConfigResponse Source # 
Instance details

Defined in Amazonka.XRay.PutEncryptionConfig

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 #

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