Create App
resiliencehub_create_app | R Documentation |
Creates an Resilience Hub application¶
Description¶
Creates an Resilience Hub application. An 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 CloudFormation stacks, Resource Groups, Terraform state files, AppRegistry applications, and an appropriate resiliency policy. In addition, you can also add resources that are located on Amazon Elastic Kubernetes Service (Amazon EKS) clusters as optional resources. For more information about the number of resources supported per application, see Service quotas.
After you create an 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).
Usage¶
resiliencehub_create_app(assessmentSchedule, clientToken, description,
eventSubscriptions, name, permissionModel, policyArn, tags)
Arguments¶
assessmentSchedule
Assessment execution schedule with 'Daily' or 'Disabled' values.
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.
description
The optional description for an app.
eventSubscriptions
The list of events you would like to subscribe and get notification for. Currently, Resilience Hub supports only Drift detected and Scheduled assessment failure events notification.
name
[required] Name of the application.
permissionModel
Defines the roles and credentials that Resilience Hub would use while creating the application, importing its resources, and running an assessment.
policyArn
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 Amazon Web Services General Reference guide.tags
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.
Value¶
A list with the following syntax:
list(
app = list(
appArn = "string",
assessmentSchedule = "Disabled"|"Daily",
complianceStatus = "PolicyBreached"|"PolicyMet"|"NotAssessed"|"ChangesDetected"|"NotApplicable"|"MissingPolicy",
creationTime = as.POSIXct(
"2015-01-01"
),
description = "string",
driftStatus = "NotChecked"|"NotDetected"|"Detected",
eventSubscriptions = list(
list(
eventType = "ScheduledAssessmentFailure"|"DriftDetected",
name = "string",
snsTopicArn = "string"
)
),
lastAppComplianceEvaluationTime = as.POSIXct(
"2015-01-01"
),
lastDriftEvaluationTime = as.POSIXct(
"2015-01-01"
),
lastResiliencyScoreEvaluationTime = as.POSIXct(
"2015-01-01"
),
name = "string",
permissionModel = list(
crossAccountRoleArns = list(
"string"
),
invokerRoleName = "string",
type = "LegacyIAMUser"|"RoleBased"
),
policyArn = "string",
resiliencyScore = 123.0,
rpoInSecs = 123,
rtoInSecs = 123,
status = "Active"|"Deleting",
tags = list(
"string"
)
)
)
Request syntax¶
svc$create_app(
assessmentSchedule = "Disabled"|"Daily",
clientToken = "string",
description = "string",
eventSubscriptions = list(
list(
eventType = "ScheduledAssessmentFailure"|"DriftDetected",
name = "string",
snsTopicArn = "string"
)
),
name = "string",
permissionModel = list(
crossAccountRoleArns = list(
"string"
),
invokerRoleName = "string",
type = "LegacyIAMUser"|"RoleBased"
),
policyArn = "string",
tags = list(
"string"
)
)