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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an AppConfig extension. An extension augments your ability to inject logic or behavior at different points during the AppConfig workflow of creating or deploying a configuration.

You can create your own extensions or use the Amazon Web Services-authored extensions provided by AppConfig. For most use-cases, to create your own extension, you must create an Lambda function to perform any computation and processing defined in the extension. For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide.

Synopsis

data CreateExtension = CreateExtension' {
- description :: Maybe Text
- latestVersionNumber :: Maybe Int
- parameters :: Maybe (HashMap Text Parameter)
- tags :: Maybe (HashMap Text Text)
- name :: Text
- actions :: HashMap ActionPoint (NonEmpty Action)
}
newCreateExtension :: Text -> CreateExtension
createExtension_description :: Lens' CreateExtension (Maybe Text)
createExtension_latestVersionNumber :: Lens' CreateExtension (Maybe Int)
createExtension_parameters :: Lens' CreateExtension (Maybe (HashMap Text Parameter))
createExtension_tags :: Lens' CreateExtension (Maybe (HashMap Text Text))
createExtension_name :: Lens' CreateExtension Text
createExtension_actions :: Lens' CreateExtension (HashMap ActionPoint (NonEmpty Action))
data Extension = Extension' {
- actions :: Maybe (HashMap ActionPoint (NonEmpty Action))
- arn :: Maybe Text
- description :: Maybe Text
- id :: Maybe Text
- name :: Maybe Text
- parameters :: Maybe (HashMap Text Parameter)
- versionNumber :: Maybe Int
}
newExtension :: Extension
extension_actions :: Lens' Extension (Maybe (HashMap ActionPoint (NonEmpty Action)))
extension_arn :: Lens' Extension (Maybe Text)
extension_description :: Lens' Extension (Maybe Text)
extension_id :: Lens' Extension (Maybe Text)
extension_name :: Lens' Extension (Maybe Text)
extension_parameters :: Lens' Extension (Maybe (HashMap Text Parameter))
extension_versionNumber :: Lens' Extension (Maybe Int)

Creating a Request

data CreateExtension Source #

See: newCreateExtension smart constructor.

Constructors

CreateExtension'

Fields

description :: Maybe Text
Information about the extension.
latestVersionNumber :: Maybe Int
You can omit this field when you create an extension. When you create a new version, specify the most recent current version number. For example, you create version 3, enter 2 for this field.
parameters :: Maybe (HashMap Text Parameter)
The parameters accepted by the extension. You specify parameter values when you associate the extension to an AppConfig resource by using the CreateExtensionAssociation API action. For Lambda extension actions, these parameters are included in the Lambda request object.
tags :: Maybe (HashMap Text Text)
Adds one or more tags for the specified extension. Tags are metadata that help you categorize resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.
name :: Text
A name for the extension. Each extension name in your account must be unique. Extension versions use the same name.
actions :: HashMap ActionPoint (NonEmpty Action)
The actions defined in the extension.

Instances

Instances details

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

newCreateExtension Source #

Arguments

:: Text	`CreateExtension`
-> CreateExtension

Create a value of CreateExtension 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:

CreateExtension, createExtension_description - Information about the extension.

$sel:latestVersionNumber:CreateExtension', createExtension_latestVersionNumber - You can omit this field when you create an extension. When you create a new version, specify the most recent current version number. For example, you create version 3, enter 2 for this field.

CreateExtension, createExtension_parameters - The parameters accepted by the extension. You specify parameter values when you associate the extension to an AppConfig resource by using the CreateExtensionAssociation API action. For Lambda extension actions, these parameters are included in the Lambda request object.

$sel:tags:CreateExtension', createExtension_tags - Adds one or more tags for the specified extension. Tags are metadata that help you categorize resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.

CreateExtension, createExtension_name - A name for the extension. Each extension name in your account must be unique. Extension versions use the same name.

CreateExtension, createExtension_actions - The actions defined in the extension.

Request Lenses

createExtension_description :: Lens' CreateExtension (Maybe Text) Source #

Information about the extension.

createExtension_latestVersionNumber :: Lens' CreateExtension (Maybe Int) Source #

You can omit this field when you create an extension. When you create a new version, specify the most recent current version number. For example, you create version 3, enter 2 for this field.

createExtension_parameters :: Lens' CreateExtension (Maybe (HashMap Text Parameter)) Source #

The parameters accepted by the extension. You specify parameter values when you associate the extension to an AppConfig resource by using the CreateExtensionAssociation API action. For Lambda extension actions, these parameters are included in the Lambda request object.

createExtension_tags :: Lens' CreateExtension (Maybe (HashMap Text Text)) Source #

Adds one or more tags for the specified extension. Tags are metadata that help you categorize resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.

createExtension_name :: Lens' CreateExtension Text Source #

A name for the extension. Each extension name in your account must be unique. Extension versions use the same name.

createExtension_actions :: Lens' CreateExtension (HashMap ActionPoint (NonEmpty Action)) Source #

The actions defined in the extension.

Destructuring the Response

data Extension Source #

See: newExtension smart constructor.

Constructors

Extension'

Fields

actions :: Maybe (HashMap ActionPoint (NonEmpty Action))
The actions defined in the extension.
arn :: Maybe Text
The system-generated Amazon Resource Name (ARN) for the extension.
description :: Maybe Text
Information about the extension.
id :: Maybe Text
The system-generated ID of the extension.
name :: Maybe Text
The extension name.
parameters :: Maybe (HashMap Text Parameter)
The parameters accepted by the extension. You specify parameter values when you associate the extension to an AppConfig resource by using the CreateExtensionAssociation API action. For Lambda extension actions, these parameters are included in the Lambda request object.
versionNumber :: Maybe Int
The extension version number.

Instances

Instances details

FromJSON Extension Source #
Instance details Defined in Amazonka.AppConfig.Types.Extension Methods parseJSON :: Value -> Parser Extension # parseJSONList :: Value -> Parser [Extension] #
Generic Extension Source #
Instance details Defined in Amazonka.AppConfig.Types.Extension Associated Types type Rep Extension :: Type -> Type # Methods from :: Extension -> Rep Extension x # to :: Rep Extension x -> Extension #
Read Extension Source #
Instance details Defined in Amazonka.AppConfig.Types.Extension Methods readsPrec :: Int -> ReadS Extension # readList :: ReadS [Extension] # readPrec :: ReadPrec Extension # readListPrec :: ReadPrec [Extension] #
Show Extension Source #
Instance details Defined in Amazonka.AppConfig.Types.Extension Methods showsPrec :: Int -> Extension -> ShowS # show :: Extension -> String # showList :: [Extension] -> ShowS #
NFData Extension Source #
Instance details Defined in Amazonka.AppConfig.Types.Extension Methods rnf :: Extension -> () #
Eq Extension Source #
Instance details Defined in Amazonka.AppConfig.Types.Extension Methods (==) :: Extension -> Extension -> Bool # (/=) :: Extension -> Extension -> Bool #
Hashable Extension Source #
Instance details Defined in Amazonka.AppConfig.Types.Extension Methods hashWithSalt :: Int -> Extension -> Int # hash :: Extension -> Int #
type Rep Extension Source #
Instance details Defined in Amazonka.AppConfig.Types.Extension type Rep Extension = D1 ('MetaData "Extension" "Amazonka.AppConfig.Types.Extension" "amazonka-appconfig-2.0-KxEFpSAUlWtLf1lFyPWujo" 'False) (C1 ('MetaCons "Extension'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "actions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap ActionPoint (NonEmpty Action)))) :: (S1 ('MetaSel ('Just "arn") '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 "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Parameter))) :: S1 ('MetaSel ('Just "versionNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))

newExtension :: Extension Source #

Create a value of Extension 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:actions:Extension', extension_actions - The actions defined in the extension.

$sel:arn:Extension', extension_arn - The system-generated Amazon Resource Name (ARN) for the extension.

Extension, extension_description - Information about the extension.

$sel:id:Extension', extension_id - The system-generated ID of the extension.

Extension, extension_name - The extension name.

$sel:parameters:Extension', extension_parameters - The parameters accepted by the extension. You specify parameter values when you associate the extension to an AppConfig resource by using the CreateExtensionAssociation API action. For Lambda extension actions, these parameters are included in the Lambda request object.

$sel:versionNumber:Extension', extension_versionNumber - The extension version number.

Response Lenses

extension_actions :: Lens' Extension (Maybe (HashMap ActionPoint (NonEmpty Action))) Source #

The actions defined in the extension.

extension_arn :: Lens' Extension (Maybe Text) Source #

The system-generated Amazon Resource Name (ARN) for the extension.

extension_description :: Lens' Extension (Maybe Text) Source #

Information about the extension.

extension_id :: Lens' Extension (Maybe Text) Source #

The system-generated ID of the extension.

extension_name :: Lens' Extension (Maybe Text) Source #

The extension name.

extension_parameters :: Lens' Extension (Maybe (HashMap Text Parameter)) Source #

The parameters accepted by the extension. You specify parameter values when you associate the extension to an AppConfig resource by using the CreateExtensionAssociation API action. For Lambda extension actions, these parameters are included in the Lambda request object.

extension_versionNumber :: Lens' Extension (Maybe Int) Source #

The extension version number.