update-field-level-encryption-config¶

Description¶

Update a field-level encryption configuration.

Synopsis¶

  update-field-level-encryption-config
--field-level-encryption-config <value>
--id <value>
[--if-match <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--field-level-encryption-config (structure)

Request to update a field-level encryption configuration.

CallerReference -> (string)

A unique number that ensures the request can’t be replayed.

Comment -> (string)

An optional comment about the configuration.

QueryArgProfileConfig -> (structure)

A complex data type that specifies when to forward content if a profile isn’t found and the profile that can be provided as a query argument in a request.

ForwardWhenQueryArgProfileIsUnknown -> (boolean)

Flag to set if you want a request to be forwarded to the origin even if the profile specified by the field-level encryption query argument, fle-profile, is unknown.

QueryArgProfiles -> (structure)

Profiles specified for query argument-profile mapping for field-level encryption.

Quantity -> (integer)

Number of profiles for query argument-profile mapping for field-level encryption.

Items -> (list)

Number of items for query argument-profile mapping for field-level encryption.

(structure)

Query argument-profile mapping for field-level encryption.

QueryArg -> (string)

Query argument for field-level encryption query argument-profile mapping.

ProfileId -> (string)

ID of profile to use for field-level encryption query argument-profile mapping

ContentTypeProfileConfig -> (structure)

A complex data type that specifies when to forward content if a content type isn’t recognized and profiles to use as by default in a request if a query argument doesn’t specify a profile to use.

ForwardWhenContentTypeIsUnknown -> (boolean)

The setting in a field-level encryption content type-profile mapping that specifies what to do when an unknown content type is provided for the profile. If true, content is forwarded without being encrypted when the content type is unknown. If false (the default), an error is returned when the content type is unknown.

ContentTypeProfiles -> (structure)

The configuration for a field-level encryption content type-profile.

Quantity -> (integer)

The number of field-level encryption content type-profile mappings.

Items -> (list)

Items in a field-level encryption content type-profile mapping.

(structure)

A field-level encryption content type profile.

Format -> (string)

The format for a field-level encryption content type-profile mapping.

ProfileId -> (string)

The profile ID for a field-level encryption content type-profile mapping.

ContentType -> (string)

The content type for a field-level encryption content type-profile mapping.

JSON Syntax:

{
  "CallerReference": "string",
  "Comment": "string",
  "QueryArgProfileConfig": {
    "ForwardWhenQueryArgProfileIsUnknown": true|false,
    "QueryArgProfiles": {
      "Quantity": integer,
      "Items": [
        {
          "QueryArg": "string",
          "ProfileId": "string"
        }
        ...
      ]
    }
  },
  "ContentTypeProfileConfig": {
    "ForwardWhenContentTypeIsUnknown": true|false,
    "ContentTypeProfiles": {
      "Quantity": integer,
      "Items": [
        {
          "Format": "URLEncoded",
          "ProfileId": "string",
          "ContentType": "string"
        }
        ...
      ]
    }
  }
}

--id (string)

The ID of the configuration you want to update.

--if-match (string)

The value of the ETag header that you received when retrieving the configuration identity to update. For example: E2QWRUHAPOMQZL .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To update a CloudFront field-level encryption configuration

The following example updates the Comment field of the field-level encryption configuration with the ID C3KM2WVD605UAY by providing the parameters in a JSON file.

To update a field-level encryption configuration, you must have the configuration’s ID and ETag. The ID is returned in the output of the create-field-level-encryption-config and list-field-level-encryption-configs commands. To get the ETag, use the get-field-level-encryption or get-field-level-encryption-config command. Use the --if-match option to provide the configuration’s ETag.

aws cloudfront update-field-level-encryption-config \
    --id C3KM2WVD605UAY \
    --if-match E2P4Z4VU7TY5SG \
    --field-level-encryption-config file://fle-config.json

The file fle-config.json is a JSON document in the current directory that contains the following:

{
    "CallerReference": "cli-example",
    "Comment": "Updated example FLE configuration",
    "QueryArgProfileConfig": {
        "ForwardWhenQueryArgProfileIsUnknown": true,
        "QueryArgProfiles": {
            "Quantity": 0
        }
    },
    "ContentTypeProfileConfig": {
        "ForwardWhenContentTypeIsUnknown": true,
        "ContentTypeProfiles": {
            "Quantity": 1,
            "Items": [
                {
                    "Format": "URLEncoded",
                    "ProfileId": "P280MFCLSYOCVU",
                    "ContentType": "application/x-www-form-urlencoded"
                }
            ]
        }
    }
}

Output:

{
    "ETag": "E26M4BIAV81ZF6",
    "FieldLevelEncryption": {
        "Id": "C3KM2WVD605UAY",
        "LastModifiedTime": "2019-12-10T22:26:26.170Z",
        "FieldLevelEncryptionConfig": {
            "CallerReference": "cli-example",
            "Comment": "Updated example FLE configuration",
            "QueryArgProfileConfig": {
                "ForwardWhenQueryArgProfileIsUnknown": true,
                "QueryArgProfiles": {
                    "Quantity": 0,
                    "Items": []
                }
            },
            "ContentTypeProfileConfig": {
                "ForwardWhenContentTypeIsUnknown": true,
                "ContentTypeProfiles": {
                    "Quantity": 1,
                    "Items": [
                        {
                            "Format": "URLEncoded",
                            "ProfileId": "P280MFCLSYOCVU",
                            "ContentType": "application/x-www-form-urlencoded"
                        }
                    ]
                }
            }
        }
    }
}

Output¶

FieldLevelEncryption -> (structure)

Return the results of updating the configuration.

Id -> (string)

The configuration ID for a field-level encryption configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.

LastModifiedTime -> (timestamp)

The last time the field-level encryption configuration was changed.

FieldLevelEncryptionConfig -> (structure)

A complex data type that includes the profile configurations specified for field-level encryption.

CallerReference -> (string)

A unique number that ensures the request can’t be replayed.

Comment -> (string)

An optional comment about the configuration.

QueryArgProfileConfig -> (structure)

A complex data type that specifies when to forward content if a profile isn’t found and the profile that can be provided as a query argument in a request.

ForwardWhenQueryArgProfileIsUnknown -> (boolean)

Flag to set if you want a request to be forwarded to the origin even if the profile specified by the field-level encryption query argument, fle-profile, is unknown.

QueryArgProfiles -> (structure)

Profiles specified for query argument-profile mapping for field-level encryption.

Quantity -> (integer)

Number of profiles for query argument-profile mapping for field-level encryption.

Items -> (list)

Number of items for query argument-profile mapping for field-level encryption.

(structure)

Query argument-profile mapping for field-level encryption.

QueryArg -> (string)

Query argument for field-level encryption query argument-profile mapping.

ProfileId -> (string)

ID of profile to use for field-level encryption query argument-profile mapping

ContentTypeProfileConfig -> (structure)

A complex data type that specifies when to forward content if a content type isn’t recognized and profiles to use as by default in a request if a query argument doesn’t specify a profile to use.

ForwardWhenContentTypeIsUnknown -> (boolean)

The setting in a field-level encryption content type-profile mapping that specifies what to do when an unknown content type is provided for the profile. If true, content is forwarded without being encrypted when the content type is unknown. If false (the default), an error is returned when the content type is unknown.

ContentTypeProfiles -> (structure)

The configuration for a field-level encryption content type-profile.

Quantity -> (integer)

The number of field-level encryption content type-profile mappings.

Items -> (list)

Items in a field-level encryption content type-profile mapping.

(structure)

A field-level encryption content type profile.

Format -> (string)

The format for a field-level encryption content type-profile mapping.

ProfileId -> (string)

The profile ID for a field-level encryption content type-profile mapping.

ContentType -> (string)

The content type for a field-level encryption content type-profile mapping.

ETag -> (string)

The value of the ETag header that you received when updating the configuration. For example: E2QWRUHAPOMQZL .

Table of Contents

Feedback

User Guide