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.FIS.CreateExperimentTemplate

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an experiment template.

An experiment template includes the following components:

Targets: A target can be a specific resource in your Amazon Web Services environment, or one or more resources that match criteria that you specify, for example, resources that have specific tags.
Actions: The actions to carry out on the target. You can specify multiple actions, the duration of each action, and when to start each action during an experiment.
Stop conditions: If a stop condition is triggered while an experiment is running, the experiment is automatically stopped. You can define a stop condition as a CloudWatch alarm.

For more information, see Experiment templates in the Fault Injection Simulator User Guide.

Synopsis

Creating a Request

data CreateExperimentTemplate Source #

See: newCreateExperimentTemplate smart constructor.

Constructors

CreateExperimentTemplate'

Fields

logConfiguration :: Maybe CreateExperimentTemplateLogConfigurationInput
The configuration for experiment logging.
tags :: Maybe (HashMap Text Text)
The tags to apply to the experiment template.
targets :: Maybe (HashMap Text CreateExperimentTemplateTargetInput)
The targets for the experiment.
clientToken :: Text
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
description :: Text
A description for the experiment template.
stopConditions :: [CreateExperimentTemplateStopConditionInput]
The stop conditions.
actions :: HashMap Text CreateExperimentTemplateActionInput
The actions for the experiment.
roleArn :: Text
The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.

Instances

Instances details

ToJSON CreateExperimentTemplate Source #
Instance details Defined in Amazonka.FIS.CreateExperimentTemplate Methods toJSON :: CreateExperimentTemplate -> Value # toEncoding :: CreateExperimentTemplate -> Encoding # toJSONList :: [CreateExperimentTemplate] -> Value # toEncodingList :: [CreateExperimentTemplate] -> Encoding #
ToHeaders CreateExperimentTemplate Source #
Instance details Defined in Amazonka.FIS.CreateExperimentTemplate Methods toHeaders :: CreateExperimentTemplate -> [Header] #
ToPath CreateExperimentTemplate Source #
Instance details Defined in Amazonka.FIS.CreateExperimentTemplate Methods toPath :: CreateExperimentTemplate -> ByteString #
ToQuery CreateExperimentTemplate Source #
Instance details Defined in Amazonka.FIS.CreateExperimentTemplate Methods toQuery :: CreateExperimentTemplate -> QueryString #
AWSRequest CreateExperimentTemplate Source #
Instance details Defined in Amazonka.FIS.CreateExperimentTemplate Associated Types type AWSResponse CreateExperimentTemplate # Methods request :: (Service -> Service) -> CreateExperimentTemplate -> Request CreateExperimentTemplate # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateExperimentTemplate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateExperimentTemplate))) #
Generic CreateExperimentTemplate Source #
Instance details Defined in Amazonka.FIS.CreateExperimentTemplate Associated Types type Rep CreateExperimentTemplate :: Type -> Type # Methods from :: CreateExperimentTemplate -> Rep CreateExperimentTemplate x # to :: Rep CreateExperimentTemplate x -> CreateExperimentTemplate #
Read CreateExperimentTemplate Source #
Instance details Defined in Amazonka.FIS.CreateExperimentTemplate Methods readsPrec :: Int -> ReadS CreateExperimentTemplate # readList :: ReadS [CreateExperimentTemplate] # readPrec :: ReadPrec CreateExperimentTemplate # readListPrec :: ReadPrec [CreateExperimentTemplate] #
Show CreateExperimentTemplate Source #
Instance details Defined in Amazonka.FIS.CreateExperimentTemplate Methods showsPrec :: Int -> CreateExperimentTemplate -> ShowS # show :: CreateExperimentTemplate -> String # showList :: [CreateExperimentTemplate] -> ShowS #
NFData CreateExperimentTemplate Source #
Instance details Defined in Amazonka.FIS.CreateExperimentTemplate Methods rnf :: CreateExperimentTemplate -> () #
Eq CreateExperimentTemplate Source #
Instance details Defined in Amazonka.FIS.CreateExperimentTemplate Methods (==) :: CreateExperimentTemplate -> CreateExperimentTemplate -> Bool # (/=) :: CreateExperimentTemplate -> CreateExperimentTemplate -> Bool #
Hashable CreateExperimentTemplate Source #
Instance details Defined in Amazonka.FIS.CreateExperimentTemplate Methods hashWithSalt :: Int -> CreateExperimentTemplate -> Int # hash :: CreateExperimentTemplate -> Int #
type AWSResponse CreateExperimentTemplate Source #
Instance details Defined in Amazonka.FIS.CreateExperimentTemplate type AWSResponse CreateExperimentTemplate = CreateExperimentTemplateResponse
type Rep CreateExperimentTemplate Source #
Instance details Defined in Amazonka.FIS.CreateExperimentTemplate type Rep CreateExperimentTemplate = D1 ('MetaData "CreateExperimentTemplate" "Amazonka.FIS.CreateExperimentTemplate" "amazonka-fis-2.0-7yQxB3RmWBm2PZyqsl0n5H" 'False) (C1 ('MetaCons "CreateExperimentTemplate'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "logConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CreateExperimentTemplateLogConfigurationInput)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "targets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text CreateExperimentTemplateTargetInput))) :: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "stopConditions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [CreateExperimentTemplateStopConditionInput])) :: (S1 ('MetaSel ('Just "actions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text CreateExperimentTemplateActionInput)) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateExperimentTemplate Source #

Arguments

:: Text	`$sel:clientToken:CreateExperimentTemplate'`
-> Text	`CreateExperimentTemplate`
-> Text	`CreateExperimentTemplate`
-> CreateExperimentTemplate

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

CreateExperimentTemplate, createExperimentTemplate_logConfiguration - The configuration for experiment logging.

CreateExperimentTemplate, createExperimentTemplate_tags - The tags to apply to the experiment template.

CreateExperimentTemplate, createExperimentTemplate_targets - The targets for the experiment.

$sel:clientToken:CreateExperimentTemplate', createExperimentTemplate_clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

CreateExperimentTemplate, createExperimentTemplate_description - A description for the experiment template.

CreateExperimentTemplate, createExperimentTemplate_stopConditions - The stop conditions.

CreateExperimentTemplate, createExperimentTemplate_actions - The actions for the experiment.

CreateExperimentTemplate, createExperimentTemplate_roleArn - The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.

Request Lenses

createExperimentTemplate_logConfiguration :: Lens' CreateExperimentTemplate (Maybe CreateExperimentTemplateLogConfigurationInput) Source #

The configuration for experiment logging.

createExperimentTemplate_tags :: Lens' CreateExperimentTemplate (Maybe (HashMap Text Text)) Source #

The tags to apply to the experiment template.

createExperimentTemplate_targets :: Lens' CreateExperimentTemplate (Maybe (HashMap Text CreateExperimentTemplateTargetInput)) Source #

The targets for the experiment.

createExperimentTemplate_clientToken :: Lens' CreateExperimentTemplate Text Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

createExperimentTemplate_description :: Lens' CreateExperimentTemplate Text Source #

A description for the experiment template.

createExperimentTemplate_stopConditions :: Lens' CreateExperimentTemplate [CreateExperimentTemplateStopConditionInput] Source #

The stop conditions.

createExperimentTemplate_actions :: Lens' CreateExperimentTemplate (HashMap Text CreateExperimentTemplateActionInput) Source #

The actions for the experiment.

createExperimentTemplate_roleArn :: Lens' CreateExperimentTemplate Text Source #

The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.

Destructuring the Response

data CreateExperimentTemplateResponse Source #

See: newCreateExperimentTemplateResponse smart constructor.

Constructors

CreateExperimentTemplateResponse'
Fields experimentTemplate :: Maybe ExperimentTemplate Information about the experiment template. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateExperimentTemplateResponse Source #
Instance details Defined in Amazonka.FIS.CreateExperimentTemplate Associated Types type Rep CreateExperimentTemplateResponse :: Type -> Type # Methods from :: CreateExperimentTemplateResponse -> Rep CreateExperimentTemplateResponse x # to :: Rep CreateExperimentTemplateResponse x -> CreateExperimentTemplateResponse #
Read CreateExperimentTemplateResponse Source #
Instance details Defined in Amazonka.FIS.CreateExperimentTemplate Methods readsPrec :: Int -> ReadS CreateExperimentTemplateResponse # readList :: ReadS [CreateExperimentTemplateResponse] # readPrec :: ReadPrec CreateExperimentTemplateResponse # readListPrec :: ReadPrec [CreateExperimentTemplateResponse] #
Show CreateExperimentTemplateResponse Source #
Instance details Defined in Amazonka.FIS.CreateExperimentTemplate Methods showsPrec :: Int -> CreateExperimentTemplateResponse -> ShowS # show :: CreateExperimentTemplateResponse -> String # showList :: [CreateExperimentTemplateResponse] -> ShowS #
NFData CreateExperimentTemplateResponse Source #
Instance details Defined in Amazonka.FIS.CreateExperimentTemplate Methods rnf :: CreateExperimentTemplateResponse -> () #
Eq CreateExperimentTemplateResponse Source #
Instance details Defined in Amazonka.FIS.CreateExperimentTemplate Methods (==) :: CreateExperimentTemplateResponse -> CreateExperimentTemplateResponse -> Bool # (/=) :: CreateExperimentTemplateResponse -> CreateExperimentTemplateResponse -> Bool #
type Rep CreateExperimentTemplateResponse Source #
Instance details Defined in Amazonka.FIS.CreateExperimentTemplate type Rep CreateExperimentTemplateResponse = D1 ('MetaData "CreateExperimentTemplateResponse" "Amazonka.FIS.CreateExperimentTemplate" "amazonka-fis-2.0-7yQxB3RmWBm2PZyqsl0n5H" 'False) (C1 ('MetaCons "CreateExperimentTemplateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "experimentTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExperimentTemplate)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateExperimentTemplateResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateExperimentTemplateResponse'`
-> CreateExperimentTemplateResponse

Create a value of CreateExperimentTemplateResponse 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:experimentTemplate:CreateExperimentTemplateResponse', createExperimentTemplateResponse_experimentTemplate - Information about the experiment template.

$sel:httpStatus:CreateExperimentTemplateResponse', createExperimentTemplateResponse_httpStatus - The response's http status code.

Response Lenses

createExperimentTemplateResponse_experimentTemplate :: Lens' CreateExperimentTemplateResponse (Maybe ExperimentTemplate) Source #

Information about the experiment template.

createExperimentTemplateResponse_httpStatus :: Lens' CreateExperimentTemplateResponse Int Source #

The response's http status code.