AWS CDK Reference

Appearance

v2.274.0

CfnConfigurationProfileProps Struct ​

Properties for defining a CfnConfigurationProfile.

Source
Generated code
Type last changed
v2.227.0 · 21 Nov 2025

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appconfig as appconfig } from 'aws-cdk-lib';
const cfnConfigurationProfileProps: appconfig.CfnConfigurationProfileProps = {
  applicationId: 'applicationId',
  locationUri: 'locationUri',
  name: 'name',

  // the properties below are optional
  deletionProtectionCheck: 'deletionProtectionCheck',
  description: 'description',
  kmsKeyIdentifier: 'kmsKeyIdentifier',
  retrievalRoleArn: 'retrievalRoleArn',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  type: 'type',
  validators: [{
    content: 'content',
    type: 'type',
  }],
};

Properties ​

applicationIdstring | IApplicationRefapplication_idtyping.Union[str, IApplicationRef]applicationIdStringApplicationIdstringApplicationIdinterface{}required#
The application ID.
deletionProtectionCheckoptionalstringdeletion_protection_checkoptionalstrdeletionProtectionCheckoptionalStringDeletionProtectionCheckoptionalstringDeletionProtectionCheckoptional*string#
A parameter to configure deletion protection.
notes

Deletion protection prevents a user from deleting a configuration profile if your application has called either GetLatestConfiguration or GetConfiguration for the configuration profile during the specified interval.

This parameter supports the following values:

  • BYPASS : Instructs AWS AppConfig to bypass the deletion protection check and delete a configuration profile even if deletion protection would have otherwise prevented it.
  • APPLY : Instructs the deletion protection check to run, even if deletion protection is disabled at the account level. APPLY also forces the deletion protection check to run against resources created in the past hour, which are normally excluded from deletion protection checks.
  • ACCOUNT_DEFAULT : The default setting, which instructs AWS AppConfig to implement the deletion protection value specified in the UpdateAccountSettings API.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A description of the configuration profile.
kmsKeyIdentifieroptionalstringkms_key_identifieroptionalstrkmsKeyIdentifieroptionalStringKmsKeyIdentifieroptionalstringKmsKeyIdentifieroptional*string#
The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
locationUristringlocation_uristrlocationUriStringLocationUristringLocationUri*stringrequired#
A URI to locate the configuration. You can specify the following:.
notes
  • For the AWS AppConfig hosted configuration store and for feature flags, specify hosted .
  • For an AWS Systems Manager Parameter Store parameter, specify either the parameter name in the format ssm-parameter://<parameter name> or the ARN.
  • For an AWS CodePipeline pipeline, specify the URI in the following format: codepipeline 😕/<pipeline name>.
  • For an AWS Secrets Manager secret, specify the URI in the following format: secretsmanager 😕/<secret name>.
  • For an Amazon S3 object, specify the URI in the following format: s3://<bucket>/<objectKey> . Here is an example: s3://amzn-s3-demo-bucket/my-app/us-east-1/my-config.json
  • For an SSM document, specify either the document name in the format ssm-document://<document name> or the Amazon Resource Name (ARN).
namestringnamestrnameStringNamestringName*stringrequired#
A name for the configuration profile.
retrievalRoleArnoptionalstring | IRoleRefretrieval_role_arnoptionaltyping.Union[str, IRoleRef]retrievalRoleArnoptionalStringRetrievalRoleArnoptionalstringRetrievalRoleArnoptionalinterface{}#
The ARN of an IAM role with permission to access the configuration at the specified `LocationUri` .

A retrieval role ARN is not required for configurations stored in AWS CodePipeline or the AWS AppConfig hosted configuration store. It is required for all other sources that store your configuration.

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
Metadata to assign to the configuration profile.

Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

typeoptionalstringtypeoptionalstrtypeoptionalStringTypeoptionalstringTypeoptional*string#
The type of configurations contained in the profile.
notes

AWS AppConfig supports feature flags and freeform configurations. We recommend you create feature flag configurations to enable or disable new features and freeform configurations to distribute configurations to an application. When calling this API, enter one of the following values for Type :

AWS.AppConfig.FeatureFlags

AWS.Freeform

validatorsoptionalIResolvable | IResolvable | CfnConfigurationProfile.ValidatorsProperty[]validatorsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ValidatorsProperty]]]validatorsoptionalIResolvableValidatorsoptionalIResolvableValidatorsoptionalinterface{}#
A list of methods for validating the configuration.