Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.AppConfig.CreateConfigurationProfile

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Synopsis

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

Creating a Request

data CreateConfigurationProfile Source #

See: newCreateConfigurationProfile smart constructor.

Constructors

CreateConfigurationProfile'

Fields

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

Instances

Instances details

Eq CreateConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.CreateConfigurationProfile Methods (==) :: CreateConfigurationProfile -> CreateConfigurationProfile -> Bool # (/=) :: CreateConfigurationProfile -> CreateConfigurationProfile -> Bool #
Show CreateConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.CreateConfigurationProfile Methods showsPrec :: Int -> CreateConfigurationProfile -> ShowS # show :: CreateConfigurationProfile -> String # showList :: [CreateConfigurationProfile] -> ShowS #
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 #
NFData CreateConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.CreateConfigurationProfile Methods rnf :: CreateConfigurationProfile -> () #
Hashable CreateConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.CreateConfigurationProfile Methods hashWithSalt :: Int -> CreateConfigurationProfile -> Int # hash :: CreateConfigurationProfile -> Int #
ToJSON CreateConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.CreateConfigurationProfile Methods toJSON :: CreateConfigurationProfile -> Value # toEncoding :: CreateConfigurationProfile -> Encoding # toJSONList :: [CreateConfigurationProfile] -> Value # toEncodingList :: [CreateConfigurationProfile] -> Encoding #
AWSRequest CreateConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.CreateConfigurationProfile Associated Types type AWSResponse CreateConfigurationProfile # Methods request :: CreateConfigurationProfile -> Request CreateConfigurationProfile # response :: MonadResource m => Logger -> Service -> Proxy CreateConfigurationProfile -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateConfigurationProfile))) #
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 #
type Rep CreateConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.CreateConfigurationProfile type Rep CreateConfigurationProfile = D1 ('MetaData "CreateConfigurationProfile" "Amazonka.AppConfig.CreateConfigurationProfile" "libZSservicesZSamazonka-appconfigZSamazonka-appconfig" 'False) (C1 ('MetaCons "CreateConfigurationProfile'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "retrievalRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "validators") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Validator])) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: 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)))))
type AWSResponse CreateConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.CreateConfigurationProfile type AWSResponse CreateConfigurationProfile = ConfigurationProfile

newCreateConfigurationProfile Source #

Arguments

:: Text	`$sel:applicationId:CreateConfigurationProfile'`
-> Text	`$sel:name:CreateConfigurationProfile'`
-> Text	`$sel:locationUri: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:

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

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

$sel:description:CreateConfigurationProfile', createConfigurationProfile_description - A description of the configuration profile.

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

$sel:applicationId:CreateConfigurationProfile', createConfigurationProfile_applicationId - The application ID.

$sel:name:CreateConfigurationProfile', createConfigurationProfile_name - A name for the configuration profile.

$sel:locationUri:CreateConfigurationProfile', createConfigurationProfile_locationUri - 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

Request Lenses

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

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

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

A list of methods for validating the configuration.

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

A description of the configuration profile.

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

Destructuring the Response

data ConfigurationProfile Source #

See: newConfigurationProfile smart constructor.

Constructors

ConfigurationProfile'

Fields

retrievalRoleArn :: Maybe Text
The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
validators :: Maybe [Validator]
A list of methods for validating the configuration.
locationUri :: Maybe Text
The URI location of the configuration.
applicationId :: Maybe Text
The application ID.
name :: Maybe Text
The name of the configuration profile.
id :: Maybe Text
The configuration profile ID.
description :: Maybe Text
The configuration profile description.

Instances

Instances details

Eq ConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.Types.ConfigurationProfile Methods (==) :: ConfigurationProfile -> ConfigurationProfile -> Bool # (/=) :: ConfigurationProfile -> ConfigurationProfile -> Bool #
Show ConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.Types.ConfigurationProfile Methods showsPrec :: Int -> ConfigurationProfile -> ShowS # show :: ConfigurationProfile -> String # showList :: [ConfigurationProfile] -> ShowS #
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 #
NFData ConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.Types.ConfigurationProfile Methods rnf :: ConfigurationProfile -> () #
Hashable ConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.Types.ConfigurationProfile Methods hashWithSalt :: Int -> ConfigurationProfile -> Int # hash :: ConfigurationProfile -> Int #
FromJSON ConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.Types.ConfigurationProfile Methods parseJSON :: Value -> Parser ConfigurationProfile # parseJSONList :: Value -> Parser [ConfigurationProfile] #
type Rep ConfigurationProfile Source #
Instance details Defined in Amazonka.AppConfig.Types.ConfigurationProfile type Rep ConfigurationProfile = D1 ('MetaData "ConfigurationProfile" "Amazonka.AppConfig.Types.ConfigurationProfile" "libZSservicesZSamazonka-appconfigZSamazonka-appconfig" 'False) (C1 ('MetaCons "ConfigurationProfile'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "retrievalRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "validators") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Validator])) :: S1 ('MetaSel ('Just "locationUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

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:retrievalRoleArn:ConfigurationProfile', configurationProfile_retrievalRoleArn - The ARN of an IAM role with permission to access the configuration at the specified LocationUri.

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

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

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

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

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

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

Response Lenses

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

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

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

A list of methods for validating the configuration.

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

The URI location of the configuration.

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

The application ID.

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

The name of the configuration profile.

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

The configuration profile ID.

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

The configuration profile description.