[ aws . appconfig ]

create-configuration-profile

Description

Information that enables AppConfig to access the configuration source. Valid configuration sources include Systems Manager (SSM) documents, SSM Parameter Store parameters, and Amazon S3 objects. 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 .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-configuration-profile
--application-id <value>
--name <value>
[--description <value>]
--location-uri <value>
[--retrieval-role-arn <value>]
[--validators <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--application-id (string)

The application ID.

--name (string)

A name for the configuration profile.

--description (string)

A description of the configuration profile.

--location-uri (string)

A URI to locate the configuration. You can specify a Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. 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

--retrieval-role-arn (string)

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

--validators (list)

A list of methods for validating the configuration.

(structure)

A validator provides a syntactic or semantic check to ensure the configuration you want to deploy functions as intended. To validate your application configuration data, you provide a schema or a Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.

Type -> (string)

AppConfig supports validators of type JSON_SCHEMA and LAMBDA

Content -> (string)

Either the JSON Schema content or the Amazon Resource Name (ARN) of an AWS Lambda function.

Shorthand Syntax:

Type=string,Content=string ...

JSON Syntax:

[
  {
    "Type": "JSON_SCHEMA"|"LAMBDA",
    "Content": "string"
  }
  ...
]

--tags (map)

Metadata to assign to the configuration profile. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

ApplicationId -> (string)

The application ID.

Id -> (string)

The configuration profile ID.

Name -> (string)

The name of the configuration profile.

Description -> (string)

The configuration profile description.

LocationUri -> (string)

The URI location of the configuration.

RetrievalRoleArn -> (string)

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

Validators -> (list)

A list of methods for validating the configuration.

(structure)

A validator provides a syntactic or semantic check to ensure the configuration you want to deploy functions as intended. To validate your application configuration data, you provide a schema or a Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.

Type -> (string)

AppConfig supports validators of type JSON_SCHEMA and LAMBDA

Content -> (string)

Either the JSON Schema content or the Amazon Resource Name (ARN) of an AWS Lambda function.