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.ResilienceHub.Types.RecommendationTemplate

Description

Synopsis

data RecommendationTemplate = RecommendationTemplate' {
- appArn :: Maybe Text
- endTime :: Maybe POSIX
- message :: Maybe Text
- needsReplacements :: Maybe Bool
- recommendationIds :: Maybe (NonEmpty Text)
- startTime :: Maybe POSIX
- tags :: Maybe (Sensitive (HashMap Text Text))
- templatesLocation :: Maybe S3Location
- assessmentArn :: Text
- format :: TemplateFormat
- name :: Text
- recommendationTemplateArn :: Text
- recommendationTypes :: NonEmpty RenderRecommendationType
- status :: RecommendationTemplateStatus
}
newRecommendationTemplate :: Text -> TemplateFormat -> Text -> Text -> NonEmpty RenderRecommendationType -> RecommendationTemplateStatus -> RecommendationTemplate
recommendationTemplate_appArn :: Lens' RecommendationTemplate (Maybe Text)
recommendationTemplate_endTime :: Lens' RecommendationTemplate (Maybe UTCTime)
recommendationTemplate_message :: Lens' RecommendationTemplate (Maybe Text)
recommendationTemplate_needsReplacements :: Lens' RecommendationTemplate (Maybe Bool)
recommendationTemplate_recommendationIds :: Lens' RecommendationTemplate (Maybe (NonEmpty Text))
recommendationTemplate_startTime :: Lens' RecommendationTemplate (Maybe UTCTime)
recommendationTemplate_tags :: Lens' RecommendationTemplate (Maybe (HashMap Text Text))
recommendationTemplate_templatesLocation :: Lens' RecommendationTemplate (Maybe S3Location)
recommendationTemplate_assessmentArn :: Lens' RecommendationTemplate Text
recommendationTemplate_format :: Lens' RecommendationTemplate TemplateFormat
recommendationTemplate_name :: Lens' RecommendationTemplate Text
recommendationTemplate_recommendationTemplateArn :: Lens' RecommendationTemplate Text
recommendationTemplate_recommendationTypes :: Lens' RecommendationTemplate (NonEmpty RenderRecommendationType)
recommendationTemplate_status :: Lens' RecommendationTemplate RecommendationTemplateStatus

Documentation

data RecommendationTemplate Source #

Defines a recommendation template created with the CreateRecommendationTemplate action.

See: newRecommendationTemplate smart constructor.

Constructors

RecommendationTemplate'

Fields

appArn :: Maybe Text
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
endTime :: Maybe POSIX
The end time for the action.
message :: Maybe Text
The message for the recommendation template.
needsReplacements :: Maybe Bool
Indicates if replacements are needed.
recommendationIds :: Maybe (NonEmpty Text)
Identifiers for the recommendations used in the recommendation template.
startTime :: Maybe POSIX
The start time for the action.
tags :: Maybe (Sensitive (HashMap Text Text))
The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
templatesLocation :: Maybe S3Location
The file location of the template.
assessmentArn :: Text
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
format :: TemplateFormat
The format of the recommendation template.
CfnJson
The template is CloudFormation JSON.
CfnYaml
The template is CloudFormation YAML.
name :: Text
The name for the recommendation template.
recommendationTemplateArn :: Text
The Amazon Resource Name (ARN) for the recommendation template.
recommendationTypes :: NonEmpty RenderRecommendationType
An array of strings that specify the recommendation template type or types.
Alarm
The template is an AlarmRecommendation template.
Sop
The template is a SopRecommendation template.
Test
The template is a TestRecommendation template.
status :: RecommendationTemplateStatus
The status of the action.

Instances

Instances details

FromJSON RecommendationTemplate Source #
Instance details Defined in Amazonka.ResilienceHub.Types.RecommendationTemplate Methods parseJSON :: Value -> Parser RecommendationTemplate # parseJSONList :: Value -> Parser [RecommendationTemplate] #
Generic RecommendationTemplate Source #
Instance details Defined in Amazonka.ResilienceHub.Types.RecommendationTemplate Associated Types type Rep RecommendationTemplate :: Type -> Type # Methods from :: RecommendationTemplate -> Rep RecommendationTemplate x # to :: Rep RecommendationTemplate x -> RecommendationTemplate #
Show RecommendationTemplate Source #
Instance details Defined in Amazonka.ResilienceHub.Types.RecommendationTemplate Methods showsPrec :: Int -> RecommendationTemplate -> ShowS # show :: RecommendationTemplate -> String # showList :: [RecommendationTemplate] -> ShowS #
NFData RecommendationTemplate Source #
Instance details Defined in Amazonka.ResilienceHub.Types.RecommendationTemplate Methods rnf :: RecommendationTemplate -> () #
Eq RecommendationTemplate Source #
Instance details Defined in Amazonka.ResilienceHub.Types.RecommendationTemplate Methods (==) :: RecommendationTemplate -> RecommendationTemplate -> Bool # (/=) :: RecommendationTemplate -> RecommendationTemplate -> Bool #
Hashable RecommendationTemplate Source #
Instance details Defined in Amazonka.ResilienceHub.Types.RecommendationTemplate Methods hashWithSalt :: Int -> RecommendationTemplate -> Int # hash :: RecommendationTemplate -> Int #
type Rep RecommendationTemplate Source #
Instance details Defined in Amazonka.ResilienceHub.Types.RecommendationTemplate type Rep RecommendationTemplate = D1 ('MetaData "RecommendationTemplate" "Amazonka.ResilienceHub.Types.RecommendationTemplate" "amazonka-resiliencehub-2.0-EsKgNhAb0B96cCxrYtrBzG" 'False) (C1 ('MetaCons "RecommendationTemplate'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "appArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "needsReplacements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "recommendationIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text)))) :: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (HashMap Text Text))))))) :: ((S1 ('MetaSel ('Just "templatesLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Location)) :: (S1 ('MetaSel ('Just "assessmentArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TemplateFormat))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "recommendationTemplateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "recommendationTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty RenderRecommendationType)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RecommendationTemplateStatus))))))

newRecommendationTemplate Source #

Arguments

:: Text	`$sel:assessmentArn:RecommendationTemplate'`
-> TemplateFormat	`$sel:format:RecommendationTemplate'`
-> Text	`$sel:name:RecommendationTemplate'`
-> Text	`$sel:recommendationTemplateArn:RecommendationTemplate'`
-> NonEmpty RenderRecommendationType	`$sel:recommendationTypes:RecommendationTemplate'`
-> RecommendationTemplateStatus	`$sel:status:RecommendationTemplate'`
-> RecommendationTemplate

Create a value of RecommendationTemplate 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:appArn:RecommendationTemplate', recommendationTemplate_appArn - The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

$sel:endTime:RecommendationTemplate', recommendationTemplate_endTime - The end time for the action.

$sel:message:RecommendationTemplate', recommendationTemplate_message - The message for the recommendation template.

$sel:needsReplacements:RecommendationTemplate', recommendationTemplate_needsReplacements - Indicates if replacements are needed.

$sel:recommendationIds:RecommendationTemplate', recommendationTemplate_recommendationIds - Identifiers for the recommendations used in the recommendation template.

$sel:startTime:RecommendationTemplate', recommendationTemplate_startTime - The start time for the action.

$sel:tags:RecommendationTemplate', recommendationTemplate_tags - The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

$sel:templatesLocation:RecommendationTemplate', recommendationTemplate_templatesLocation - The file location of the template.

$sel:assessmentArn:RecommendationTemplate', recommendationTemplate_assessmentArn - The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

$sel:format:RecommendationTemplate', recommendationTemplate_format - The format of the recommendation template.

CfnJson: The template is CloudFormation JSON.
CfnYaml: The template is CloudFormation YAML.

$sel:name:RecommendationTemplate', recommendationTemplate_name - The name for the recommendation template.

$sel:recommendationTemplateArn:RecommendationTemplate', recommendationTemplate_recommendationTemplateArn - The Amazon Resource Name (ARN) for the recommendation template.

$sel:recommendationTypes:RecommendationTemplate', recommendationTemplate_recommendationTypes - An array of strings that specify the recommendation template type or types.

Alarm: The template is an AlarmRecommendation template.
Sop: The template is a SopRecommendation template.
Test: The template is a TestRecommendation template.

$sel:status:RecommendationTemplate', recommendationTemplate_status - The status of the action.

recommendationTemplate_appArn :: Lens' RecommendationTemplate (Maybe Text) Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

recommendationTemplate_endTime :: Lens' RecommendationTemplate (Maybe UTCTime) Source #

The end time for the action.

recommendationTemplate_message :: Lens' RecommendationTemplate (Maybe Text) Source #

The message for the recommendation template.

recommendationTemplate_needsReplacements :: Lens' RecommendationTemplate (Maybe Bool) Source #

Indicates if replacements are needed.

recommendationTemplate_recommendationIds :: Lens' RecommendationTemplate (Maybe (NonEmpty Text)) Source #

Identifiers for the recommendations used in the recommendation template.

recommendationTemplate_startTime :: Lens' RecommendationTemplate (Maybe UTCTime) Source #

The start time for the action.

recommendationTemplate_tags :: Lens' RecommendationTemplate (Maybe (HashMap Text Text)) Source #

The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

recommendationTemplate_templatesLocation :: Lens' RecommendationTemplate (Maybe S3Location) Source #

The file location of the template.

recommendationTemplate_assessmentArn :: Lens' RecommendationTemplate Text Source #

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

recommendationTemplate_format :: Lens' RecommendationTemplate TemplateFormat Source #

The format of the recommendation template.

CfnJson: The template is CloudFormation JSON.
CfnYaml: The template is CloudFormation YAML.

recommendationTemplate_name :: Lens' RecommendationTemplate Text Source #

The name for the recommendation template.

recommendationTemplate_recommendationTemplateArn :: Lens' RecommendationTemplate Text Source #

The Amazon Resource Name (ARN) for the recommendation template.

recommendationTemplate_recommendationTypes :: Lens' RecommendationTemplate (NonEmpty RenderRecommendationType) Source #

An array of strings that specify the recommendation template type or types.

Alarm: The template is an AlarmRecommendation template.
Sop: The template is a SopRecommendation template.
Test: The template is a TestRecommendation template.

recommendationTemplate_status :: Lens' RecommendationTemplate RecommendationTemplateStatus Source #

The status of the action.