aws-cdk-lib.aws_appconfig.CfnConfigurationProfileProps

interface CfnConfigurationProfileProps

LanguageType name
.NETAmazon.CDK.AWS.AppConfig.CfnConfigurationProfileProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappconfig#CfnConfigurationProfileProps
Javasoftware.amazon.awscdk.services.appconfig.CfnConfigurationProfileProps
Pythonaws_cdk.aws_appconfig.CfnConfigurationProfileProps
TypeScript aws-cdk-lib » aws_appconfig » CfnConfigurationProfileProps

Properties for defining a CfnConfigurationProfile.

Example

// 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
  description: 'description',
  retrievalRoleArn: 'retrievalRoleArn',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  type: 'type',
  validators: [{
    content: 'content',
    type: 'type',
  }],
};

Properties

NameTypeDescription
applicationIdstringThe application ID.
locationUristringA URI to locate the configuration. You can specify the following:.
namestringA name for the configuration profile.
description?stringA description of the configuration profile.
retrievalRoleArn?stringThe ARN of an IAM role with permission to access the configuration at the specified LocationUri .
tags?TagsProperty[]Metadata to assign to the configuration profile.
type?stringThe type of configurations contained in the profile.
validators?IResolvable | IResolvable | ValidatorsProperty[]A list of methods for validating the configuration.

applicationId

Type: string

The application ID.


locationUri

Type: string

A URI to locate the configuration. You can specify the following:.

  • 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 ://.
  • For an AWS Secrets Manager secret, specify the URI in the following format: secretsmanager ://.
  • For an Amazon S3 object, specify the URI in the following format: s3://<bucket>/<objectKey> . Here is an example: s3://my-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).

name

Type: string

A name for the configuration profile.


description?

Type: string (optional)

A description of the configuration profile.


retrievalRoleArn?

Type: string (optional)

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 the AWS AppConfig hosted configuration store. It is required for all other sources that store your configuration.


tags?

Type: TagsProperty[] (optional)

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.


type?

Type: string (optional)

The type of configurations contained in the profile.

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


validators?

Type: IResolvable | IResolvable | ValidatorsProperty[] (optional)

A list of methods for validating the configuration.