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 |
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.
RecommendationTemplate' | |
|
Instances
newRecommendationTemplate Source #
:: Text | |
-> TemplateFormat | |
-> Text | |
-> Text | |
-> NonEmpty RenderRecommendationType | |
-> RecommendationTemplateStatus | |
-> 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.