CreateConfigurationProfile - AWS AppConfig

CreateConfigurationProfile

Creates a configuration profile, which is information that enables AWS AppConfig to access the configuration source. Valid configuration sources include the following:

  • Configuration data in YAML, JSON, and other formats stored in the AWS AppConfig hosted configuration store

  • Configuration data stored as objects in an Amazon Simple Storage Service (Amazon S3) bucket

  • Pipelines stored in AWS CodePipeline

  • Secrets stored in AWS Secrets Manager

  • Standard and secure string parameters stored in AWS Systems Manager Parameter Store

  • Configuration data in SSM documents stored in the Systems Manager document store

A configuration profile includes the following information:

  • The URI location of the configuration data.

  • The AWS Identity and Access Management (IAM) role that provides access to the configuration data.

  • A validator for the configuration data. Available validators include either a JSON Schema or an AWS Lambda function.

For more information, see Create a Configuration and a Configuration Profile in the AWS AppConfig User Guide.

Request Syntax

POST /applications/ApplicationId/configurationprofiles HTTP/1.1 Content-type: application/json { "Description": "string", "KmsKeyIdentifier": "string", "LocationUri": "string", "Name": "string", "RetrievalRoleArn": "string", "Tags": { "string" : "string" }, "Type": "string", "Validators": [ { "Content": "string", "Type": "string" } ] }

URI Request Parameters

The request uses the following URI parameters.

ApplicationId

The application ID.

Pattern: [a-z0-9]{4,7}

Required: Yes

Request Body

The request accepts the following data in JSON format.

Description

A description of the configuration profile.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

KmsKeyIdentifier

The identifier for an AWS Key Management Service key to encrypt new configuration data versions in the AWS AppConfig hosted configuration store. This attribute is only used for hosted configuration types. The identifier can be an AWS KMS key ID, alias, or the Amazon Resource Name (ARN) of the key ID or alias. To encrypt data managed in other configuration stores, see the documentation for how to specify an AWS KMS key for that particular service.

Type: String

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}|alias/[a-zA-Z0-9/_-]{1,250}|arn:aws[a-zA-Z-]*:kms:[a-z]{2}(-gov|-iso(b?))?-[a-z]+-\d{1}:\d{12}:(key/[0-9a-f-]{36}|alias/[a-zA-Z0-9/_-]{1,250})$

Required: No

LocationUri

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://<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://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).

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: Yes

Name

A name for the configuration profile.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

RetrievalRoleArn

The ARN of an IAM role with permission to access the configuration at the specified LocationUri.

Important

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.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^((arn):(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):(iam)::\d{12}:role[/].*)$

Required: No

Tags

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: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Required: No

Type

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

Type: String

Pattern: ^[a-zA-Z\.]+

Required: No

Validators

A list of methods for validating the configuration.

Type: Array of Validator objects

Array Members: Minimum number of 0 items. Maximum number of 2 items.

Required: No

Response Syntax

HTTP/1.1 201 Content-type: application/json { "ApplicationId": "string", "Description": "string", "Id": "string", "KmsKeyArn": "string", "KmsKeyIdentifier": "string", "LocationUri": "string", "Name": "string", "RetrievalRoleArn": "string", "Type": "string", "Validators": [ { "Content": "string", "Type": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

ApplicationId

The application ID.

Type: String

Pattern: [a-z0-9]{4,7}

Description

The configuration profile description.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Id

The configuration profile ID.

Type: String

Pattern: [a-z0-9]{4,7}

KmsKeyArn

The Amazon Resource Name of the AWS Key Management Service key to encrypt new configuration data versions in the AWS AppConfig hosted configuration store. This attribute is only used for hosted configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an AWS KMS key for that particular service.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:(aws[a-zA-Z-]*)?:[a-z]+:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+

KmsKeyIdentifier

The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.

Type: String

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}|alias/[a-zA-Z0-9/_-]{1,250}|arn:aws[a-zA-Z-]*:kms:[a-z]{2}(-gov|-iso(b?))?-[a-z]+-\d{1}:\d{12}:(key/[0-9a-f-]{36}|alias/[a-zA-Z0-9/_-]{1,250})$

LocationUri

The URI location of the configuration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Name

The name of the configuration profile.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

RetrievalRoleArn

The ARN of an IAM role with permission to access the configuration at the specified LocationUri.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^((arn):(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):(iam)::\d{12}:role[/].*)$

Type

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

Type: String

Pattern: ^[a-zA-Z\.]+

Validators

A list of methods for validating the configuration.

Type: Array of Validator objects

Array Members: Minimum number of 0 items. Maximum number of 2 items.

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

InternalServerException

There was an internal failure in the AWS AppConfig service.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource could not be found.

HTTP Status Code: 404

ServiceQuotaExceededException

The number of one more AWS AppConfig resources exceeds the maximum allowed. Verify that your environment doesn't exceed the following service quotas:

Applications: 100 max

Deployment strategies: 20 max

Configuration profiles: 100 max per application

Environments: 20 max per application

To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AWS AppConfig in the Amazon Web Services General Reference.

HTTP Status Code: 402

Examples

Example

This example illustrates one usage of CreateConfigurationProfile.

Sample Request

POST /applications/abc1234/configurationprofiles HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/x86_64.amzn.2 prompt/off command/appconfig.create-configuration-profile X-Amz-Date: 20210916T190059Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210916/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 171 { "Name": "Example-Configuration-Profile", "LocationUri": "ssm-parameter://Example-Parameter", "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role" }

Sample Response

{ "ApplicationId": "abc1234", "Description": null, "Id": "ur8hx2f", "LocationUri": "ssm-parameter://Example-Parameter", "Name": "Example-Configuration-Profile", "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role", "Type": null, "Validators": null }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: