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

FieldTypeRequiredDescription
appAssessmentScheduleenum—Assessment execution schedule. Allowed: Disabled, Daily
appTemplateBodystringyesA string containing full ResilienceHub app template body.
descriptionstring—App description.
eventSubscriptionsarray<object>—The list of events you would like to subscribe and get notification for.
eventSubscriptions[].eventTypeenumyesThe type of event you would like to subscribe and get notification for. Allowed: ScheduledAssessmentFailure, DriftDetected
eventSubscriptions[].namestringyesUnique name to identify an event subscription.
eventSubscriptions[].snsTopicArnstring—Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic.
namestringyesName of the app.
permissionModelobject—ResilienceHubAppPermissionModel is a nested property type of AWS::ResilienceHub::App.
permissionModel.crossAccountRoleArnsarray<string>—Defines a list of role Amazon Resource Names (ARNs) to be used in other accounts.
permissionModel.invokerRoleNamestring—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.typeenumyesDefines how AWS Resilience Hub scans your resources. Allowed: LegacyIAMUser, RoleBased
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
resiliencyPolicyArnstring—Amazon Resource Name (ARN) of the Resiliency Policy.
resourceMappingsarray<object>yesAn array of ResourceMapping objects.
resourceMappings[].eksSourceNamestring—
resourceMappings[].logicalStackNamestring—
resourceMappings[].mappingTypestringyes
resourceMappings[].physicalResourceIdobjectyesResilienceHubAppPhysicalResourceId is a nested property type of AWS::ResilienceHub::App.
resourceMappings[].physicalResourceId.awsAccountIdstring—
resourceMappings[].physicalResourceId.awsRegionstring—
resourceMappings[].physicalResourceId.identifierstringyes
resourceMappings[].physicalResourceId.typestringyes
resourceMappings[].resourceNamestring—
resourceMappings[].terraformSourceNamestring—
tagsmap<string>—

Status

FieldTypeRequiredDescription
appArnstring—Amazon Resource Name (ARN) of the App.
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
driftStatusenum—Indicates if compliance drifts (deviations) were detected while running an assessment for your application. Allowed: NotChecked, NotDetected, Detected
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—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

FieldTypeRequiredDescription
dataLocationConstraintenum—Data Location Constraint of the Policy. Allowed: AnyLocation, SameContinent, SameCountry
policyobjectyesResilienceHubResiliencyPolicyPolicyMap is a nested property type of AWS::ResilienceHub::ResiliencyPolicy.
policy.azobjectyesResilienceHubResiliencyPolicyFailurePolicy is a nested property type of AWS::ResilienceHub::ResiliencyPolicy.
policy.az.rpoInSecsintegeryesRPO in seconds.
policy.az.rtoInSecsintegeryesRTO in seconds.
policy.hardwareobjectyesResilienceHubResiliencyPolicyFailurePolicy is a nested property type of AWS::ResilienceHub::ResiliencyPolicy.
policy.hardware.rpoInSecsintegeryesRPO in seconds.
policy.hardware.rtoInSecsintegeryesRTO in seconds.
policy.regionobject—ResilienceHubResiliencyPolicyFailurePolicy is a nested property type of AWS::ResilienceHub::ResiliencyPolicy.
policy.region.rpoInSecsintegeryesRPO in seconds.
policy.region.rtoInSecsintegeryesRTO in seconds.
policy.softwareobjectyesResilienceHubResiliencyPolicyFailurePolicy is a nested property type of AWS::ResilienceHub::ResiliencyPolicy.
policy.software.rpoInSecsintegeryesRPO in seconds.
policy.software.rtoInSecsintegeryesRTO in seconds.
policyDescriptionstring—Description of Resiliency Policy.
policyNamestringyesName of Resiliency Policy.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
tagsmap<string>—
tierenumyesResiliency Policy Tier. Allowed: MissionCritical, Critical, Important, CoreServices, NonCritical

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
policyArnstring—Amazon Resource Name (ARN) of the Resiliency Policy.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.