amazonka-appconfig-2.0: Amazon AppConfig SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.AppConfig.CreateExtensionAssociation

Description

When you create an extension or configure an Amazon Web Services-authored extension, you associate the extension with an AppConfig application, environment, or configuration profile. For example, you can choose to run the AppConfig deployment events to Amazon SNS Amazon Web Services-authored extension and receive notifications on an Amazon SNS topic anytime a configuration deployment is started for a specific application. Defining which extension to associate with an AppConfig resource is called an extension association. An extension association is a specified relationship between an extension and an AppConfig resource, such as an application or a configuration profile. For more information about extensions and associations, see Working with AppConfig extensions in the AppConfig User Guide.

Synopsis

Creating a Request

data CreateExtensionAssociation Source #

See: newCreateExtensionAssociation smart constructor.

Constructors

CreateExtensionAssociation' 

Fields

  • extensionVersionNumber :: Maybe Int

    The version number of the extension. If not specified, AppConfig uses the maximum version of the extension.

  • parameters :: Maybe (HashMap Text Text)

    The parameter names and values defined in the extensions. Extension parameters marked Required must be entered for this field.

  • tags :: Maybe (HashMap Text Text)

    Adds one or more tags for the specified extension association. 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.

  • extensionIdentifier :: Text

    The name, the ID, or the Amazon Resource Name (ARN) of the extension.

  • resourceIdentifier :: Text

    The ARN of an application, configuration profile, or environment.

Instances

Instances details
ToJSON CreateExtensionAssociation Source # 
Instance details

Defined in Amazonka.AppConfig.CreateExtensionAssociation

ToHeaders CreateExtensionAssociation Source # 
Instance details

Defined in Amazonka.AppConfig.CreateExtensionAssociation

ToPath CreateExtensionAssociation Source # 
Instance details

Defined in Amazonka.AppConfig.CreateExtensionAssociation

ToQuery CreateExtensionAssociation Source # 
Instance details

Defined in Amazonka.AppConfig.CreateExtensionAssociation

AWSRequest CreateExtensionAssociation Source # 
Instance details

Defined in Amazonka.AppConfig.CreateExtensionAssociation

Generic CreateExtensionAssociation Source # 
Instance details

Defined in Amazonka.AppConfig.CreateExtensionAssociation

Associated Types

type Rep CreateExtensionAssociation :: Type -> Type #

Read CreateExtensionAssociation Source # 
Instance details

Defined in Amazonka.AppConfig.CreateExtensionAssociation

Show CreateExtensionAssociation Source # 
Instance details

Defined in Amazonka.AppConfig.CreateExtensionAssociation

NFData CreateExtensionAssociation Source # 
Instance details

Defined in Amazonka.AppConfig.CreateExtensionAssociation

Eq CreateExtensionAssociation Source # 
Instance details

Defined in Amazonka.AppConfig.CreateExtensionAssociation

Hashable CreateExtensionAssociation Source # 
Instance details

Defined in Amazonka.AppConfig.CreateExtensionAssociation

type AWSResponse CreateExtensionAssociation Source # 
Instance details

Defined in Amazonka.AppConfig.CreateExtensionAssociation

type Rep CreateExtensionAssociation Source # 
Instance details

Defined in Amazonka.AppConfig.CreateExtensionAssociation

type Rep CreateExtensionAssociation = D1 ('MetaData "CreateExtensionAssociation" "Amazonka.AppConfig.CreateExtensionAssociation" "amazonka-appconfig-2.0-KxEFpSAUlWtLf1lFyPWujo" 'False) (C1 ('MetaCons "CreateExtensionAssociation'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "extensionVersionNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "extensionIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "resourceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateExtensionAssociation Source #

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

CreateExtensionAssociation, createExtensionAssociation_extensionVersionNumber - The version number of the extension. If not specified, AppConfig uses the maximum version of the extension.

CreateExtensionAssociation, createExtensionAssociation_parameters - The parameter names and values defined in the extensions. Extension parameters marked Required must be entered for this field.

$sel:tags:CreateExtensionAssociation', createExtensionAssociation_tags - Adds one or more tags for the specified extension association. 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.

CreateExtensionAssociation, createExtensionAssociation_extensionIdentifier - The name, the ID, or the Amazon Resource Name (ARN) of the extension.

$sel:resourceIdentifier:CreateExtensionAssociation', createExtensionAssociation_resourceIdentifier - The ARN of an application, configuration profile, or environment.

Request Lenses

createExtensionAssociation_extensionVersionNumber :: Lens' CreateExtensionAssociation (Maybe Int) Source #

The version number of the extension. If not specified, AppConfig uses the maximum version of the extension.

createExtensionAssociation_parameters :: Lens' CreateExtensionAssociation (Maybe (HashMap Text Text)) Source #

The parameter names and values defined in the extensions. Extension parameters marked Required must be entered for this field.

createExtensionAssociation_tags :: Lens' CreateExtensionAssociation (Maybe (HashMap Text Text)) Source #

Adds one or more tags for the specified extension association. 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.

createExtensionAssociation_extensionIdentifier :: Lens' CreateExtensionAssociation Text Source #

The name, the ID, or the Amazon Resource Name (ARN) of the extension.

createExtensionAssociation_resourceIdentifier :: Lens' CreateExtensionAssociation Text Source #

The ARN of an application, configuration profile, or environment.

Destructuring the Response

data ExtensionAssociation Source #

See: newExtensionAssociation smart constructor.

Constructors

ExtensionAssociation' 

Fields

Instances

Instances details
FromJSON ExtensionAssociation Source # 
Instance details

Defined in Amazonka.AppConfig.Types.ExtensionAssociation

Generic ExtensionAssociation Source # 
Instance details

Defined in Amazonka.AppConfig.Types.ExtensionAssociation

Associated Types

type Rep ExtensionAssociation :: Type -> Type #

Read ExtensionAssociation Source # 
Instance details

Defined in Amazonka.AppConfig.Types.ExtensionAssociation

Show ExtensionAssociation Source # 
Instance details

Defined in Amazonka.AppConfig.Types.ExtensionAssociation

NFData ExtensionAssociation Source # 
Instance details

Defined in Amazonka.AppConfig.Types.ExtensionAssociation

Methods

rnf :: ExtensionAssociation -> () #

Eq ExtensionAssociation Source # 
Instance details

Defined in Amazonka.AppConfig.Types.ExtensionAssociation

Hashable ExtensionAssociation Source # 
Instance details

Defined in Amazonka.AppConfig.Types.ExtensionAssociation

type Rep ExtensionAssociation Source # 
Instance details

Defined in Amazonka.AppConfig.Types.ExtensionAssociation

type Rep ExtensionAssociation = D1 ('MetaData "ExtensionAssociation" "Amazonka.AppConfig.Types.ExtensionAssociation" "amazonka-appconfig-2.0-KxEFpSAUlWtLf1lFyPWujo" 'False) (C1 ('MetaCons "ExtensionAssociation'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "extensionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "extensionVersionNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newExtensionAssociation :: ExtensionAssociation Source #

Create a value of ExtensionAssociation 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:arn:ExtensionAssociation', extensionAssociation_arn - The system-generated Amazon Resource Name (ARN) for the extension.

$sel:extensionArn:ExtensionAssociation', extensionAssociation_extensionArn - The ARN of the extension defined in the association.

$sel:extensionVersionNumber:ExtensionAssociation', extensionAssociation_extensionVersionNumber - The version number for the extension defined in the association.

$sel:id:ExtensionAssociation', extensionAssociation_id - The system-generated ID for the association.

$sel:parameters:ExtensionAssociation', extensionAssociation_parameters - The parameter names and values defined in the association.

$sel:resourceArn:ExtensionAssociation', extensionAssociation_resourceArn - The ARNs of applications, configuration profiles, or environments defined in the association.

Response Lenses

extensionAssociation_arn :: Lens' ExtensionAssociation (Maybe Text) Source #

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

extensionAssociation_extensionArn :: Lens' ExtensionAssociation (Maybe Text) Source #

The ARN of the extension defined in the association.

extensionAssociation_extensionVersionNumber :: Lens' ExtensionAssociation (Maybe Int) Source #

The version number for the extension defined in the association.

extensionAssociation_id :: Lens' ExtensionAssociation (Maybe Text) Source #

The system-generated ID for the association.

extensionAssociation_parameters :: Lens' ExtensionAssociation (Maybe (HashMap Text Text)) Source #

The parameter names and values defined in the association.

extensionAssociation_resourceArn :: Lens' ExtensionAssociation (Maybe Text) Source #

The ARNs of applications, configuration profiles, or environments defined in the association.