Skip to content
v2.275.0

CfnFieldLevelEncryptionConfigProps Struct Added in v2.275.0 ​

Properties for defining a CfnFieldLevelEncryptionConfig.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudfront as cloudfront } from 'aws-cdk-lib';
const cfnFieldLevelEncryptionConfigProps: cloudfront.CfnFieldLevelEncryptionConfigProps = {
  callerReference: 'callerReference',
  contentTypeProfileConfig: {
    contentTypeProfiles: [{
      contentType: 'contentType',
      format: 'format',
      profileId: 'profileId',
    }],
    forwardWhenContentTypeIsUnknown: false,
  },
  queryArgProfileConfig: {
    forwardWhenQueryArgProfileIsUnknown: false,
    queryArgProfiles: [{
      profileId: 'profileId',
      queryArg: 'queryArg',
    }],
  },

  // the properties below are optional
  comment: 'comment',
};

Properties ​

callerReferencestringcaller_referencestrcallerReferenceStringCallerReferencestringCallerReference*stringrequired#
A unique value that identifies the create request.
notes

Any string unique within the account works; CloudFront refuses to change it once set, so supplying a different value replaces the configuration. It is also the only value CloudFront returns that identifies a configuration as this stack's, so cleaning up after a failed create depends on the template keeping it.

commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string#
An optional comment describing the field-level encryption configuration.
notes

CloudFront stores an omitted comment and an explicitly empty one identically as an empty string, and Read normalizes that empty string back to absent -- so omitting Comment round-trips, while asking for an empty string does not and would report perpetual drift. minLength: 1 refuses the empty string at template validation; omission is the way to express no comment. The service documents a maximum of 128 characters, and maxLength moves that refusal from the API to template validation.

contentTypeProfileConfigIResolvable | CfnFieldLevelEncryptionConfig.ContentTypeProfileConfigPropertycontent_type_profile_configtyping.Union[IResolvable, ContentTypeProfileConfigProperty]contentTypeProfileConfigIResolvableContentTypeProfileConfigIResolvableContentTypeProfileConfiginterface{}required#
How CloudFront handles content types, including the profile paired with each one.
queryArgProfileConfigIResolvable | CfnFieldLevelEncryptionConfig.QueryArgProfileConfigPropertyquery_arg_profile_configtyping.Union[IResolvable, QueryArgProfileConfigProperty]queryArgProfileConfigIResolvableQueryArgProfileConfigIResolvableQueryArgProfileConfiginterface{}required#
How CloudFront handles query arguments, including the profile paired with each one.