Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AppConfig.CreateConfigurationProfile

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a configuration profile, which is information that enables AppConfig to access the configuration source. Valid configuration sources include the AppConfig hosted configuration store, Amazon Web Services Systems Manager (SSM) documents, SSM Parameter Store parameters, Amazon S3 objects, or any integration source action supported by CodePipeline. 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.

Synopsis

data CreateConfigurationProfile = CreateConfigurationProfile' {
- description :: Maybe Text
- retrievalRoleArn :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- type' :: Maybe Text
- validators :: Maybe [Validator]
- applicationId :: Text
- name :: Text
- locationUri :: Text
}
newCreateConfigurationProfile :: Text -> Text -> Text -> CreateConfigurationProfile
createConfigurationProfile_description :: Lens' CreateConfigurationProfile (Maybe Text)
createConfigurationProfile_retrievalRoleArn :: Lens' CreateConfigurationProfile (Maybe Text)
createConfigurationProfile_tags :: Lens' CreateConfigurationProfile (Maybe (HashMap Text Text))
createConfigurationProfile_type :: Lens' CreateConfigurationProfile (Maybe Text)
createConfigurationProfile_validators :: Lens' CreateConfigurationProfile (Maybe [Validator])
createConfigurationProfile_applicationId :: Lens' CreateConfigurationProfile Text
createConfigurationProfile_name :: Lens' CreateConfigurationProfile Text
createConfigurationProfile_locationUri :: Lens' CreateConfigurationProfile Text
data ConfigurationProfile = ConfigurationProfile' {
- applicationId :: Maybe Text
- description :: Maybe Text
- id :: Maybe Text
- locationUri :: Maybe Text
- name :: Maybe Text
- retrievalRoleArn :: Maybe Text
- type' :: Maybe Text
- validators :: Maybe [Validator]
}
newConfigurationProfile :: ConfigurationProfile
configurationProfile_applicationId :: Lens' ConfigurationProfile (Maybe Text)
configurationProfile_description :: Lens' ConfigurationProfile (Maybe Text)
configurationProfile_id :: Lens' ConfigurationProfile (Maybe Text)
configurationProfile_locationUri :: Lens' ConfigurationProfile (Maybe Text)
configurationProfile_name :: Lens' ConfigurationProfile (Maybe Text)
configurationProfile_retrievalRoleArn :: Lens' ConfigurationProfile (Maybe Text)
configurationProfile_type :: Lens' ConfigurationProfile (Maybe Text)
configurationProfile_validators :: Lens' ConfigurationProfile (Maybe [Validator])

Creating a Request

data CreateConfigurationProfile Source #

See: newCreateConfigurationProfile smart constructor.

Constructors

CreateConfigurationProfile'

Fields

description :: Maybe Text
A description of the configuration profile.
retrievalRoleArn :: Maybe Text
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 :: Maybe (HashMap Text Text)
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' :: Maybe Text
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 :: Maybe [Validator]
A list of methods for validating the configuration.
applicationId :: Text
The application ID.
name :: Text
A name for the configuration profile.
locationUri :: Text
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 and for feature flags, 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

Instances

Instances details

ToJSON CreateConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.CreateConfigurationProfile Methods toJSON :: CreateConfigurationProfile -> Value # toEncoding :: CreateConfigurationProfile -> Encoding # toJSONList :: [CreateConfigurationProfile] -> Value # toEncodingList :: [CreateConfigurationProfile] -> Encoding #
ToHeaders CreateConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.CreateConfigurationProfile Methods toHeaders :: CreateConfigurationProfile -> [Header] #
ToPath CreateConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.CreateConfigurationProfile Methods toPath :: CreateConfigurationProfile -> ByteString #
ToQuery CreateConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.CreateConfigurationProfile Methods toQuery :: CreateConfigurationProfile -> QueryString #
AWSRequest CreateConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.CreateConfigurationProfile Associated Types type AWSResponse CreateConfigurationProfile # Methods request :: (Service -> Service) -> CreateConfigurationProfile -> Request CreateConfigurationProfile # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateConfigurationProfile -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateConfigurationProfile))) #
Generic CreateConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.CreateConfigurationProfile Associated Types type Rep CreateConfigurationProfile :: Type -> Type # Methods from :: CreateConfigurationProfile -> Rep CreateConfigurationProfile x # to :: Rep CreateConfigurationProfile x -> CreateConfigurationProfile #
Show CreateConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.CreateConfigurationProfile Methods showsPrec :: Int -> CreateConfigurationProfile -> ShowS # show :: CreateConfigurationProfile -> String # showList :: [CreateConfigurationProfile] -> ShowS #
NFData CreateConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.CreateConfigurationProfile Methods rnf :: CreateConfigurationProfile -> () #
Eq CreateConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.CreateConfigurationProfile Methods (==) :: CreateConfigurationProfile -> CreateConfigurationProfile -> Bool # (/=) :: CreateConfigurationProfile -> CreateConfigurationProfile -> Bool #
Hashable CreateConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.CreateConfigurationProfile Methods hashWithSalt :: Int -> CreateConfigurationProfile -> Int # hash :: CreateConfigurationProfile -> Int #
type AWSResponse CreateConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.CreateConfigurationProfile type AWSResponse CreateConfigurationProfile = ConfigurationProfile
type Rep CreateConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.CreateConfigurationProfile type Rep CreateConfigurationProfile = D1 ('MetaData "CreateConfigurationProfile" "Amazonka.AppConfig.CreateConfigurationProfile" "amazonka-appconfig-2.0-KxEFpSAUlWtLf1lFyPWujo" 'False) (C1 ('MetaCons "CreateConfigurationProfile'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "retrievalRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "validators") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Validator])) :: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "locationUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateConfigurationProfile Source #

Arguments

:: Text	`CreateConfigurationProfile`
-> Text	`CreateConfigurationProfile`
-> Text	`CreateConfigurationProfile`
-> CreateConfigurationProfile

Create a value of CreateConfigurationProfile with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateConfigurationProfile, createConfigurationProfile_description - A description of the configuration profile.

CreateConfigurationProfile, createConfigurationProfile_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.

$sel:tags:CreateConfigurationProfile', createConfigurationProfile_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.

CreateConfigurationProfile, createConfigurationProfile_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

CreateConfigurationProfile, createConfigurationProfile_validators - A list of methods for validating the configuration.

CreateConfigurationProfile, createConfigurationProfile_applicationId - The application ID.

CreateConfigurationProfile, createConfigurationProfile_name - A name for the configuration profile.

CreateConfigurationProfile, createConfigurationProfile_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 and for feature flags, 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

Request Lenses

createConfigurationProfile_description :: Lens' CreateConfigurationProfile (Maybe Text) Source #

A description of the configuration profile.

createConfigurationProfile_retrievalRoleArn :: Lens' CreateConfigurationProfile (Maybe Text) Source #

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.

createConfigurationProfile_tags :: Lens' CreateConfigurationProfile (Maybe (HashMap Text Text)) Source #

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.

createConfigurationProfile_type :: Lens' CreateConfigurationProfile (Maybe Text) Source #

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

createConfigurationProfile_validators :: Lens' CreateConfigurationProfile (Maybe [Validator]) Source #

A list of methods for validating the configuration.

createConfigurationProfile_applicationId :: Lens' CreateConfigurationProfile Text Source #

The application ID.

createConfigurationProfile_name :: Lens' CreateConfigurationProfile Text Source #

A name for the configuration profile.

createConfigurationProfile_locationUri :: Lens' CreateConfigurationProfile Text Source #

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 and for feature flags, 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

Destructuring the Response

data ConfigurationProfile Source #

See: newConfigurationProfile smart constructor.

Constructors

ConfigurationProfile'

Fields

applicationId :: Maybe Text
The application ID.
description :: Maybe Text
The configuration profile description.
id :: Maybe Text
The configuration profile ID.
locationUri :: Maybe Text
The URI location of the configuration.
name :: Maybe Text
The name of the configuration profile.
retrievalRoleArn :: Maybe Text
The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
type' :: Maybe Text
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 :: Maybe [Validator]
A list of methods for validating the configuration.

Instances

Instances details

FromJSON ConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.Types.ConfigurationProfile Methods parseJSON :: Value -> Parser ConfigurationProfile # parseJSONList :: Value -> Parser [ConfigurationProfile] #
Generic ConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.Types.ConfigurationProfile Associated Types type Rep ConfigurationProfile :: Type -> Type # Methods from :: ConfigurationProfile -> Rep ConfigurationProfile x # to :: Rep ConfigurationProfile x -> ConfigurationProfile #
Show ConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.Types.ConfigurationProfile Methods showsPrec :: Int -> ConfigurationProfile -> ShowS # show :: ConfigurationProfile -> String # showList :: [ConfigurationProfile] -> ShowS #
NFData ConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.Types.ConfigurationProfile Methods rnf :: ConfigurationProfile -> () #
Eq ConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.Types.ConfigurationProfile Methods (==) :: ConfigurationProfile -> ConfigurationProfile -> Bool # (/=) :: ConfigurationProfile -> ConfigurationProfile -> Bool #
Hashable ConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.Types.ConfigurationProfile Methods hashWithSalt :: Int -> ConfigurationProfile -> Int # hash :: ConfigurationProfile -> Int #
type Rep ConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.Types.ConfigurationProfile type Rep ConfigurationProfile = D1 ('MetaData "ConfigurationProfile" "Amazonka.AppConfig.Types.ConfigurationProfile" "amazonka-appconfig-2.0-KxEFpSAUlWtLf1lFyPWujo" 'False) (C1 ('MetaCons "ConfigurationProfile'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "locationUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "retrievalRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "validators") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Validator]))))))

newConfigurationProfile :: ConfigurationProfile Source #

Create a value of ConfigurationProfile with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:applicationId:ConfigurationProfile', configurationProfile_applicationId - The application ID.

$sel:description:ConfigurationProfile', configurationProfile_description - The configuration profile description.

$sel:id:ConfigurationProfile', configurationProfile_id - The configuration profile ID.

$sel:locationUri:ConfigurationProfile', configurationProfile_locationUri - The URI location of the configuration.

$sel:name:ConfigurationProfile', configurationProfile_name - The name of the configuration profile.

$sel:retrievalRoleArn:ConfigurationProfile', configurationProfile_retrievalRoleArn - The ARN of an IAM role with permission to access the configuration at the specified LocationUri.

ConfigurationProfile, configurationProfile_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

$sel:validators:ConfigurationProfile', configurationProfile_validators - A list of methods for validating the configuration.

Response Lenses

configurationProfile_applicationId :: Lens' ConfigurationProfile (Maybe Text) Source #

The application ID.

configurationProfile_description :: Lens' ConfigurationProfile (Maybe Text) Source #

The configuration profile description.

configurationProfile_id :: Lens' ConfigurationProfile (Maybe Text) Source #

The configuration profile ID.

configurationProfile_locationUri :: Lens' ConfigurationProfile (Maybe Text) Source #

The URI location of the configuration.

configurationProfile_name :: Lens' ConfigurationProfile (Maybe Text) Source #

The name of the configuration profile.

configurationProfile_retrievalRoleArn :: Lens' ConfigurationProfile (Maybe Text) Source #

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

configurationProfile_type :: Lens' ConfigurationProfile (Maybe Text) Source #

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

configurationProfile_validators :: Lens' ConfigurationProfile (Maybe [Validator]) Source #

A list of methods for validating the configuration.