CreateConfigurationProfileRequest Class

Container for the parameters to the CreateConfigurationProfile operation. Creates a configuration profile, which is information that enables AppConfig to access the configuration source. Valid configuration sources include the following:

Configuration data in YAML, JSON, and other formats stored in the AppConfig hosted configuration store
Configuration data stored as objects in an Amazon Simple Storage Service (Amazon S3) bucket
Pipelines stored in CodePipeline
Secrets stored in Secrets Manager
Standard and secure string parameters stored in Amazon Web Services 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 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 Amazon Web Services Lambda function.

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.AppConfig.AmazonAppConfigRequest
      Amazon.AppConfig.Model.CreateConfigurationProfileRequest

Namespace: Amazon.AppConfig.Model
Assembly: AWSSDK.AppConfig.dll
Version: 3.x.y.z

Syntax

public class CreateConfigurationProfileRequest : AmazonAppConfigRequest
         IAmazonWebServiceRequest

The CreateConfigurationProfileRequest type exposes the following members

Constructors

	Name	Description
	CreateConfigurationProfileRequest()

Properties

Name	Type	Description
ApplicationId	System.String	Gets and sets the property ApplicationId. The application ID.
Description	System.String	Gets and sets the property Description. A description of the configuration profile.
KmsKeyIdentifier	System.String	Gets and sets the property KmsKeyIdentifier. The identifier for an Key Management Service key to encrypt new configuration data versions in the AppConfig hosted configuration store. This attribute is only used for `hosted` configuration types. The identifier can be an 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 KMS key for that particular service.
LocationUri	System.String	Gets and sets the property LocationUri. A URI to locate the configuration. You can specify the following: For the AppConfig hosted configuration store and for feature flags, specify `hosted`. For an Amazon Web Services Systems Manager Parameter Store parameter, specify either the parameter name in the format `ssm-parameter://` or the ARN. For an Amazon Web Services CodePipeline pipeline, specify the URI in the following format: `codepipeline`://. For an Secrets Manager secret, specify the URI in the following format: `secretsmanager`://. For an Amazon S3 object, specify the URI in the following format: `s3:///`. 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://` or the Amazon Resource Name (ARN).
Name	System.String	Gets and sets the property Name. A name for the configuration profile.
RetrievalRoleArn	System.String	Gets and sets the property RetrievalRoleArn. 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 AppConfig hosted configuration store. It is required for all other sources that store your configuration.
Tags	System.Collections.Generic.Dictionary<System.String, System.String>	Gets and sets the property Tags. 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.
Type	System.String	Gets and sets the property Type. The type of configurations contained in the profile. 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	System.Collections.Generic.List<Amazon.AppConfig.Model.Validator>	Gets and sets the property Validators. A list of methods for validating the configuration.

Examples

The following create-configuration-profile example creates a configuration profile using a configuration stored in Parameter Store, a capability of Systems Manager.

To create a configuration profile


var client = new AmazonAppConfigClient();
var response = client.CreateConfigurationProfile(new CreateConfigurationProfileRequest 
{
    ApplicationId = "339ohji",
    LocationUri = "ssm-parameter://Example-Parameter",
    Name = "Example-Configuration-Profile",
    RetrievalRoleArn = "arn:aws:iam::111122223333:role/Example-App-Config-Role"
});

string applicationId = response.ApplicationId;
string id = response.Id;
string locationUri = response.LocationUri;
string name = response.Name;
string retrievalRoleArn = response.RetrievalRoleArn;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5