Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateConfigurationProfile

Information that enables AWS AppConfig to access the configuration source. Valid configuration sources include the AppConfig hosted configuration store, Systems Manager (SSM) documents, SSM Parameter Store parameters, Amazon S3 objects, or any integration source action supported by AWS CodePipeline. 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",
   "LocationUri": "string",
   "Name": "string",
   "RetrievalRoleArn": "string",
   "Tags": { 
      "string" : "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

LocationUri

A URI to locate the configuration. You can specify the AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. For the hosted configuration store, specify hosted. For an SSM document, specify either the document name in the format ssm-document://<Document_name> or the Amazon Resource Name (ARN). For a parameter, specify either the parameter name in the format ssm-parameter://<Parameter_name> or the ARN. 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

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 64.

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 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

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",
   "LocationUri": "string",
   "Name": "string",
   "RetrievalRoleArn": "string",
   "Validators": [ 
      { 
         "Content": "string",
         "Type": "string"
      }
   ]
}