Resilience Hub
2 resource kinds. Generated from the operator's CRD schemas.
API Group:
aws.konfig.io/v1alpha1
ResilienceHubApp # CLOUD CONTROL · AWS::ResilienceHub::App
ResilienceHubApp manages AWS::ResilienceHub::App through the AWS Cloud Control API.
kubectl get resiliencehubapps · example on GitHub
Example
# ResilienceHubApp — Resilience Hub
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/resiliencehub.html#resiliencehubapp
apiVersion: aws.konfig.io/v1alpha1
kind: ResilienceHubApp
metadata:
name: example-resiliencehubapp
namespace: default
spec:
appAssessmentSchedule: Disabled
appTemplateBody: example
description: Managed by konfig-konector
eventSubscriptions:
- eventType: ScheduledAssessmentFailure
name: example-resiliencehubapp
snsTopicArn: arn:aws:iam::123456789012:role/example-role
name: example-resiliencehubapp
permissionModel:
crossAccountRoleArns:
- arn:aws:iam::123456789012:role/example-role
invokerRoleName: example-resiliencehubapp
type: LegacyIAMUser
providerRef:
name: example-resiliencehubapp
region: us-east-1
resiliencyPolicyArn: arn:aws:iam::123456789012:role/example-role
resourceMappings:
- eksSourceName: example-resiliencehubapp
logicalStackName: example-resiliencehubapp
mappingType: example
physicalResourceId:
awsAccountId: '123456789012'
awsRegion: example
identifier: example
type: example
resourceName: example-resiliencehubapp
terraformSourceName: example-resiliencehubapp
tags:
environment: dev
team: platform
Spec
| Field | Type | Required | Description |
|---|---|---|---|
appAssessmentSchedule | enum | — | Assessment execution schedule. Allowed: Disabled, Daily |
appTemplateBody | string | yes | A string containing full ResilienceHub app template body. |
description | string | — | App description. |
eventSubscriptions | array<object> | — | The list of events you would like to subscribe and get notification for. |
eventSubscriptions[].eventType | enum | yes | The type of event you would like to subscribe and get notification for. Allowed: ScheduledAssessmentFailure, DriftDetected |
eventSubscriptions[].name | string | yes | Unique name to identify an event subscription. |
eventSubscriptions[].snsTopicArn | string | — | Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic. |
name | string | yes | Name of the app. |
permissionModel | object | — | ResilienceHubAppPermissionModel is a nested property type of AWS::ResilienceHub::App. |
permissionModel.crossAccountRoleArns | array<string> | — | Defines a list of role Amazon Resource Names (ARNs) to be used in other accounts. |
permissionModel.invokerRoleName | string | — | Existing AWS IAM role name in the primary AWS account that will be assumed by AWS Resilience Hub Service Principle to obtain a read-only access to your application resources while running an assessment. |
permissionModel.type | enum | yes | Defines how AWS Resilience Hub scans your resources. Allowed: LegacyIAMUser, RoleBased |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
resiliencyPolicyArn | string | — | Amazon Resource Name (ARN) of the Resiliency Policy. |
resourceMappings | array<object> | yes | An array of ResourceMapping objects. |
resourceMappings[].eksSourceName | string | — | |
resourceMappings[].logicalStackName | string | — | |
resourceMappings[].mappingType | string | yes | |
resourceMappings[].physicalResourceId | object | yes | ResilienceHubAppPhysicalResourceId is a nested property type of AWS::ResilienceHub::App. |
resourceMappings[].physicalResourceId.awsAccountId | string | — | |
resourceMappings[].physicalResourceId.awsRegion | string | — | |
resourceMappings[].physicalResourceId.identifier | string | yes | |
resourceMappings[].physicalResourceId.type | string | yes | |
resourceMappings[].resourceName | string | — | |
resourceMappings[].terraformSourceName | string | — | |
tags | map<string> | — |
Status
| Field | Type | Required | Description |
|---|---|---|---|
appArn | string | — | Amazon Resource Name (ARN) of the App. |
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
driftStatus | enum | — | Indicates if compliance drifts (deviations) were detected while running an assessment for your application. Allowed: NotChecked, NotDetected, Detected |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
ResilienceHubResiliencyPolicy # CLOUD CONTROL · AWS::ResilienceHub::ResiliencyPolicy
ResilienceHubResiliencyPolicy manages AWS::ResilienceHub::ResiliencyPolicy through the AWS Cloud Control API.
kubectl get resiliencehubresiliencypolicies · example on GitHub
Example
# ResilienceHubResiliencyPolicy — Resilience Hub
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/resiliencehub.html#resiliencehubresiliencypolicy
apiVersion: aws.konfig.io/v1alpha1
kind: ResilienceHubResiliencyPolicy
metadata:
name: example-resiliencehubresiliencypolicy
namespace: default
spec:
dataLocationConstraint: AnyLocation
policy:
az:
rpoInSecs: 1
rtoInSecs: 1
hardware:
rpoInSecs: 1
rtoInSecs: 1
region:
rpoInSecs: 1
rtoInSecs: 1
software:
rpoInSecs: 1
rtoInSecs: 1
policyDescription: Managed by konfig-konector
policyName: example-resiliencehubresiliencypolicy
providerRef:
name: example-resiliencehubresiliencypolicy
region: us-east-1
tags:
environment: dev
team: platform
tier: MissionCritical
Spec
| Field | Type | Required | Description |
|---|---|---|---|
dataLocationConstraint | enum | — | Data Location Constraint of the Policy. Allowed: AnyLocation, SameContinent, SameCountry |
policy | object | yes | ResilienceHubResiliencyPolicyPolicyMap is a nested property type of AWS::ResilienceHub::ResiliencyPolicy. |
policy.az | object | yes | ResilienceHubResiliencyPolicyFailurePolicy is a nested property type of AWS::ResilienceHub::ResiliencyPolicy. |
policy.az.rpoInSecs | integer | yes | RPO in seconds. |
policy.az.rtoInSecs | integer | yes | RTO in seconds. |
policy.hardware | object | yes | ResilienceHubResiliencyPolicyFailurePolicy is a nested property type of AWS::ResilienceHub::ResiliencyPolicy. |
policy.hardware.rpoInSecs | integer | yes | RPO in seconds. |
policy.hardware.rtoInSecs | integer | yes | RTO in seconds. |
policy.region | object | — | ResilienceHubResiliencyPolicyFailurePolicy is a nested property type of AWS::ResilienceHub::ResiliencyPolicy. |
policy.region.rpoInSecs | integer | yes | RPO in seconds. |
policy.region.rtoInSecs | integer | yes | RTO in seconds. |
policy.software | object | yes | ResilienceHubResiliencyPolicyFailurePolicy is a nested property type of AWS::ResilienceHub::ResiliencyPolicy. |
policy.software.rpoInSecs | integer | yes | RPO in seconds. |
policy.software.rtoInSecs | integer | yes | RTO in seconds. |
policyDescription | string | — | Description of Resiliency Policy. |
policyName | string | yes | Name of Resiliency Policy. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
tags | map<string> | — | |
tier | enum | yes | Resiliency Policy Tier. Allowed: MissionCritical, Critical, Important, CoreServices, NonCritical |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
policyArn | string | — | Amazon Resource Name (ARN) of the Resiliency Policy. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |