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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a Resilience Hub application. A Resilience Hub application is a collection of Amazon Web Services resources structured to prevent and recover Amazon Web Services application disruptions. To describe a Resilience Hub application, you provide an application name, resources from one or more–up to five–CloudFormation stacks, and an appropriate resiliency policy.

After you create a Resilience Hub application, you publish it so that you can run a resiliency assessment on it. You can then use recommendations from the assessment to improve resiliency by running another assessment, comparing results, and then iterating the process until you achieve your goals for recovery time objective (RTO) and recovery point objective (RPO).

Synopsis

data CreateApp = CreateApp' {
- assessmentSchedule :: Maybe AppAssessmentScheduleType
- clientToken :: Maybe Text
- description :: Maybe Text
- policyArn :: Maybe Text
- tags :: Maybe (Sensitive (HashMap Text Text))
- name :: Text
}
newCreateApp :: Text -> CreateApp
createApp_assessmentSchedule :: Lens' CreateApp (Maybe AppAssessmentScheduleType)
createApp_clientToken :: Lens' CreateApp (Maybe Text)
createApp_description :: Lens' CreateApp (Maybe Text)
createApp_policyArn :: Lens' CreateApp (Maybe Text)
createApp_tags :: Lens' CreateApp (Maybe (HashMap Text Text))
createApp_name :: Lens' CreateApp Text
data CreateAppResponse = CreateAppResponse' {
- httpStatus :: Int
- app :: App
}
newCreateAppResponse :: Int -> App -> CreateAppResponse
createAppResponse_httpStatus :: Lens' CreateAppResponse Int
createAppResponse_app :: Lens' CreateAppResponse App

Creating a Request

data CreateApp Source #

See: newCreateApp smart constructor.

Constructors

CreateApp'

Fields

assessmentSchedule :: Maybe AppAssessmentScheduleType
Assessment execution schedule with 'Daily' or 'Disabled' values.
clientToken :: Maybe Text
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
description :: Maybe Text
The optional description for an app.
policyArn :: Maybe Text
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
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.
name :: Text
The name for the application.

Instances

Instances details

ToJSON CreateApp Source #
Instance details Defined in Amazonka.ResilienceHub.CreateApp Methods toJSON :: CreateApp -> Value # toEncoding :: CreateApp -> Encoding # toJSONList :: [CreateApp] -> Value # toEncodingList :: [CreateApp] -> Encoding #
ToHeaders CreateApp Source #
Instance details Defined in Amazonka.ResilienceHub.CreateApp Methods toHeaders :: CreateApp -> [Header] #
ToPath CreateApp Source #
Instance details Defined in Amazonka.ResilienceHub.CreateApp Methods toPath :: CreateApp -> ByteString #
ToQuery CreateApp Source #
Instance details Defined in Amazonka.ResilienceHub.CreateApp Methods toQuery :: CreateApp -> QueryString #
AWSRequest CreateApp Source #
Instance details Defined in Amazonka.ResilienceHub.CreateApp Associated Types type AWSResponse CreateApp # Methods request :: (Service -> Service) -> CreateApp -> Request CreateApp # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateApp -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateApp))) #
Generic CreateApp Source #
Instance details Defined in Amazonka.ResilienceHub.CreateApp Associated Types type Rep CreateApp :: Type -> Type # Methods from :: CreateApp -> Rep CreateApp x # to :: Rep CreateApp x -> CreateApp #
Show CreateApp Source #
Instance details Defined in Amazonka.ResilienceHub.CreateApp Methods showsPrec :: Int -> CreateApp -> ShowS # show :: CreateApp -> String # showList :: [CreateApp] -> ShowS #
NFData CreateApp Source #
Instance details Defined in Amazonka.ResilienceHub.CreateApp Methods rnf :: CreateApp -> () #
Eq CreateApp Source #
Instance details Defined in Amazonka.ResilienceHub.CreateApp Methods (==) :: CreateApp -> CreateApp -> Bool # (/=) :: CreateApp -> CreateApp -> Bool #
Hashable CreateApp Source #
Instance details Defined in Amazonka.ResilienceHub.CreateApp Methods hashWithSalt :: Int -> CreateApp -> Int # hash :: CreateApp -> Int #
type AWSResponse CreateApp Source #
Instance details Defined in Amazonka.ResilienceHub.CreateApp type AWSResponse CreateApp = CreateAppResponse
type Rep CreateApp Source #
Instance details Defined in Amazonka.ResilienceHub.CreateApp type Rep CreateApp = D1 ('MetaData "CreateApp" "Amazonka.ResilienceHub.CreateApp" "amazonka-resiliencehub-2.0-EsKgNhAb0B96cCxrYtrBzG" 'False) (C1 ('MetaCons "CreateApp'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "assessmentSchedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AppAssessmentScheduleType)) :: (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "policyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (HashMap Text Text)))) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateApp Source #

Arguments

:: Text	`CreateApp`
-> CreateApp

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

CreateApp, createApp_assessmentSchedule - Assessment execution schedule with 'Daily' or 'Disabled' values.

$sel:clientToken:CreateApp', createApp_clientToken - Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

CreateApp, createApp_description - The optional description for an app.

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

CreateApp, createApp_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.

CreateApp, createApp_name - The name for the application.

Request Lenses

createApp_assessmentSchedule :: Lens' CreateApp (Maybe AppAssessmentScheduleType) Source #

Assessment execution schedule with 'Daily' or 'Disabled' values.

createApp_clientToken :: Lens' CreateApp (Maybe Text) Source #

Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

createApp_description :: Lens' CreateApp (Maybe Text) Source #

The optional description for an app.

createApp_policyArn :: Lens' CreateApp (Maybe Text) Source #

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

createApp_tags :: Lens' CreateApp (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.

createApp_name :: Lens' CreateApp Text Source #

The name for the application.

Destructuring the Response

data CreateAppResponse Source #

See: newCreateAppResponse smart constructor.

Constructors

CreateAppResponse'
Fields httpStatus :: Int The response's http status code. app :: App The created application returned as an object with details including compliance status, creation time, description, resiliency score, and more.

Instances

Instances details

Generic CreateAppResponse Source #
Instance details Defined in Amazonka.ResilienceHub.CreateApp Associated Types type Rep CreateAppResponse :: Type -> Type # Methods from :: CreateAppResponse -> Rep CreateAppResponse x # to :: Rep CreateAppResponse x -> CreateAppResponse #
Show CreateAppResponse Source #
Instance details Defined in Amazonka.ResilienceHub.CreateApp Methods showsPrec :: Int -> CreateAppResponse -> ShowS # show :: CreateAppResponse -> String # showList :: [CreateAppResponse] -> ShowS #
NFData CreateAppResponse Source #
Instance details Defined in Amazonka.ResilienceHub.CreateApp Methods rnf :: CreateAppResponse -> () #
Eq CreateAppResponse Source #
Instance details Defined in Amazonka.ResilienceHub.CreateApp Methods (==) :: CreateAppResponse -> CreateAppResponse -> Bool # (/=) :: CreateAppResponse -> CreateAppResponse -> Bool #
type Rep CreateAppResponse Source #
Instance details Defined in Amazonka.ResilienceHub.CreateApp type Rep CreateAppResponse = D1 ('MetaData "CreateAppResponse" "Amazonka.ResilienceHub.CreateApp" "amazonka-resiliencehub-2.0-EsKgNhAb0B96cCxrYtrBzG" 'False) (C1 ('MetaCons "CreateAppResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "app") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 App)))

newCreateAppResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateAppResponse'`
-> App	`$sel:app:CreateAppResponse'`
-> CreateAppResponse

Create a value of CreateAppResponse 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:httpStatus:CreateAppResponse', createAppResponse_httpStatus - The response's http status code.

$sel:app:CreateAppResponse', createAppResponse_app - The created application returned as an object with details including compliance status, creation time, description, resiliency score, and more.

Response Lenses

createAppResponse_httpStatus :: Lens' CreateAppResponse Int Source #

The response's http status code.

createAppResponse_app :: Lens' CreateAppResponse App Source #

The created application returned as an object with details including compliance status, creation time, description, resiliency score, and more.