Resilience Hub v2
5 resource kinds. Generated from the operator's CRD schemas.
aws.konfig.io/v1alpha1
ResilienceHubV2Policy # CLOUD CONTROL · AWS::ResilienceHubV2::Policy
ResilienceHubV2Policy manages AWS::ResilienceHubV2::Policy through the AWS Cloud Control API.
kubectl get resiliencehubv2policies · example on GitHub
Example
# ResilienceHubV2Policy — Resilience Hub v2
# 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/resiliencehubv2.html#resiliencehubv2policy
apiVersion: aws.konfig.io/v1alpha1
kind: ResilienceHubV2Policy
metadata:
name: example-resiliencehubv2policy
namespace: default
spec:
availabilitySlo:
target: 1
dataRecovery:
timeBetweenBackupsInMinutes: 1
description: Managed by konfig-konector
kmsKeyId: arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
multiAz:
disasterRecoveryApproach: ACTIVE_ACTIVE
rpoInMinutes: 1
rtoInMinutes: 1
multiRegion:
disasterRecoveryApproach: ACTIVE_ACTIVE
rpoInMinutes: 1
rtoInMinutes: 1
name: example-resiliencehubv2policy
providerRef:
name: example-resiliencehubv2policy
region: us-east-1
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
availabilitySlo | object | — | ResilienceHubV2PolicyAvailabilitySlo is a nested property type of AWS::ResilienceHubV2::Policy. |
availabilitySlo.target | number | — | Availability target percentage. |
dataRecovery | object | — | ResilienceHubV2PolicyDataRecoveryTargets is a nested property type of AWS::ResilienceHubV2::Policy. |
dataRecovery.timeBetweenBackupsInMinutes | integer | — | Time between backups in minutes. |
description | string | — | The description of the policy. |
kmsKeyId | string | — | The KMS key ID for encrypting policy data. |
multiAz | object | — | ResilienceHubV2PolicyMultiAzTargets is a nested property type of AWS::ResilienceHubV2::Policy. |
multiAz.disasterRecoveryApproach | enum | — | Multi-AZ disaster recovery approach. Allowed: ACTIVE_ACTIVE, HOT_STANDBY, WARM_STANDBY, PILOT_LIGHT, BACKUP_AND_RESTORE |
multiAz.rpoInMinutes | integer | — | Recovery Point Objective in minutes. |
multiAz.rtoInMinutes | integer | — | Recovery Time Objective in minutes. |
multiRegion | object | — | ResilienceHubV2PolicyMultiRegionTargets is a nested property type of AWS::ResilienceHubV2::Policy. |
multiRegion.disasterRecoveryApproach | enum | — | Multi-Region disaster recovery approach. Allowed: ACTIVE_ACTIVE, HOT_STANDBY, WARM_STANDBY, PILOT_LIGHT, BACKUP_AND_RESTORE |
multiRegion.rpoInMinutes | integer | — | Recovery Point Objective in minutes. |
multiRegion.rtoInMinutes | integer | — | Recovery Time Objective in minutes. |
name | string | yes | The name of the 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 | array<object> | — | Tags assigned to the policy. |
tags[].key | string | yes | |
tags[].value | string | yes |
Status
| Field | Type | Required | Description |
|---|---|---|---|
associatedServiceCount | integer | — | The number of services associated with this policy. |
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. |
createdAt | string | — | The timestamp when the policy was created. |
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 | — | The ARN of the policy. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
updatedAt | string | — | The timestamp when the policy was last updated. |
ResilienceHubV2Service # CLOUD CONTROL · AWS::ResilienceHubV2::Service
ResilienceHubV2Service manages AWS::ResilienceHubV2::Service through the AWS Cloud Control API.
kubectl get resiliencehubv2services · example on GitHub
Example
# ResilienceHubV2Service — Resilience Hub v2
# 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/resiliencehubv2.html#resiliencehubv2service
apiVersion: aws.konfig.io/v1alpha1
kind: ResilienceHubV2Service
metadata:
name: example-resiliencehubv2service
namespace: default
spec:
assertions:
- text: example
associatedSystems:
- systemArn: arn:aws:iam::123456789012:role/example-role
userJourneyIds:
- example
dependencyDiscovery: ENABLED
description: Managed by konfig-konector
inputSources:
- resourceConfiguration:
cfnStackArn: arn:aws:iam::123456789012:role/example-role
designFileS3Url: example
resourceTags:
- key: example
values:
- example
tfStateFileUrl: example
kmsKeyId: arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
name: example-resiliencehubv2service
permissionModel:
crossAccountRoleArns:
- crossAccountRoleArn: arn:aws:iam::123456789012:role/example-role
invokerRoleName: example-resiliencehubv2service
policyArn: arn:aws:iam::123456789012:role/example-role
providerRef:
name: example-resiliencehubv2service
region: us-east-1
regions:
- example
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
assertions | array<object> | — | Assertions associated with this service. |
assertions[].text | string | yes | The text of the assertion. |
associatedSystems | array<object> | — | Systems associated with this service. |
associatedSystems[].systemArn | string | yes | The system ARN. |
associatedSystems[].userJourneyIds | array<string> | — | User journey IDs associated with this system. |
dependencyDiscovery | enum | — | Dependency discovery state. Allowed: ENABLED, DISABLED, INITIALIZING |
description | string | — | The description of the service. |
inputSources | array<object> | — | Input sources for this service. |
inputSources[].resourceConfiguration | object | yes | ResilienceHubV2ServiceResourceConfiguration is a nested property type of AWS::ResilienceHubV2::Service. |
inputSources[].resourceConfiguration.cfnStackArn | string | — | ARN of a CloudFormation stack. |
inputSources[].resourceConfiguration.designFileS3Url | string | — | S3 URL of a design file. |
inputSources[].resourceConfiguration.eks | object | — | ResilienceHubV2ServiceEksSource is a nested property type of AWS::ResilienceHubV2::Service. |
inputSources[].resourceConfiguration.eks.clusterArn | string | yes | ARN of the EKS cluster. |
inputSources[].resourceConfiguration.eks.namespaces | array<string> | yes | EKS namespaces. |
inputSources[].resourceConfiguration.resourceTags | array<object> | — | Resource tags to discover resources. |
inputSources[].resourceConfiguration.resourceTags[].key | string | yes | Tag key. |
inputSources[].resourceConfiguration.resourceTags[].values | array<string> | yes | Tag values. |
inputSources[].resourceConfiguration.tfStateFileUrl | string | — | URL of a Terraform state file. |
kmsKeyId | string | — | The KMS key ID for encrypting service data. |
name | string | yes | The name of the service. |
permissionModel | object | — | ResilienceHubV2ServicePermissionModel is a nested property type of AWS::ResilienceHubV2::Service. |
permissionModel.crossAccountRoleArns | array<object> | — | Cross-account role ARNs. |
permissionModel.crossAccountRoleArns[].crossAccountRoleArn | string | yes | ARN of the cross-account IAM role. |
permissionModel.crossAccountRoleArns[].externalId | string | — | External ID for cross-account access. |
permissionModel.invokerRoleName | string | yes | Name of the invoker IAM role. |
policyArn | string | — | The ARN of the resilience policy to associate. |
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. |
regions | array<string> | yes | AWS regions for the service. |
reportConfiguration | object | — | ResilienceHubV2ServiceServiceReportConfiguration is a nested property type of AWS::ResilienceHubV2::Service. |
reportConfiguration.reportOutput | array<object> | yes | Output destinations for generated reports. |
reportConfiguration.reportOutput[].s3 | object | — | ResilienceHubV2ServiceS3ReportOutputConfiguration is a nested property type of AWS::ResilienceHubV2::Service. |
reportConfiguration.reportOutput[].s3.bucketOwner | string | yes | Account ID of the bucket owner. |
reportConfiguration.reportOutput[].s3.bucketPath | string | yes | S3 bucket path where reports will be written. |
tags | array<object> | — | Tags assigned to the service. |
tags[].key | string | yes | |
tags[].value | string | yes |
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. |
createdAt | string | — | The timestamp when the service was created. |
effectivePolicyValues | object | — | Read-only: reported by AWS after creation. |
effectivePolicyValues.availabilitySlo | object | — | ResilienceHubV2ServiceSloSource is a nested property type of AWS::ResilienceHubV2::Service. |
effectivePolicyValues.availabilitySlo.policyName | string | — | |
effectivePolicyValues.availabilitySlo.value | number | — | |
effectivePolicyValues.multiAzDrApproach | object | — | ResilienceHubV2ServiceDisasterRecoverySource is a nested property type of AWS::ResilienceHubV2::Service. |
effectivePolicyValues.multiAzDrApproach.policyName | string | — | |
effectivePolicyValues.multiAzDrApproach.value | string | — | |
effectivePolicyValues.multiAzRpo | object | — | ResilienceHubV2ServiceTargetSource is a nested property type of AWS::ResilienceHubV2::Service. |
effectivePolicyValues.multiAzRpo.policyName | string | — | |
effectivePolicyValues.multiAzRpo.value | integer | — | |
effectivePolicyValues.multiAzRto | object | — | ResilienceHubV2ServiceTargetSource is a nested property type of AWS::ResilienceHubV2::Service. |
effectivePolicyValues.multiAzRto.policyName | string | — | |
effectivePolicyValues.multiAzRto.value | integer | — | |
effectivePolicyValues.multiRegionDrApproach | object | — | ResilienceHubV2ServiceDisasterRecoverySource is a nested property type of AWS::ResilienceHubV2::Service. |
effectivePolicyValues.multiRegionDrApproach.policyName | string | — | |
effectivePolicyValues.multiRegionDrApproach.value | string | — | |
effectivePolicyValues.multiRegionRpo | object | — | ResilienceHubV2ServiceTargetSource is a nested property type of AWS::ResilienceHubV2::Service. |
effectivePolicyValues.multiRegionRpo.policyName | string | — | |
effectivePolicyValues.multiRegionRpo.value | integer | — | |
effectivePolicyValues.multiRegionRto | object | — | ResilienceHubV2ServiceTargetSource is a nested property type of AWS::ResilienceHubV2::Service. |
effectivePolicyValues.multiRegionRto.policyName | string | — | |
effectivePolicyValues.multiRegionRto.value | integer | — | |
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. |
serviceArn | string | — | The ARN of the service. |
updatedAt | string | — | The timestamp when the service was last updated. |
ResilienceHubV2ServiceFunction # CLOUD CONTROL · AWS::ResilienceHubV2::ServiceFunction
ResilienceHubV2ServiceFunction manages AWS::ResilienceHubV2::ServiceFunction through the AWS Cloud Control API.
kubectl get resiliencehubv2servicefunctions · example on GitHub
Example
# ResilienceHubV2ServiceFunction — Resilience Hub v2
# 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/resiliencehubv2.html#resiliencehubv2servicefunction
apiVersion: aws.konfig.io/v1alpha1
kind: ResilienceHubV2ServiceFunction
metadata:
name: example-resiliencehubv2servicefunction
namespace: default
spec:
criticality: PRIMARY
description: Managed by konfig-konector
name: example-resiliencehubv2servicefunction
providerRef:
name: example-resiliencehubv2servicefunction
region: us-east-1
serviceArn: arn:aws:iam::123456789012:role/example-role
Spec
| Field | Type | Required | Description |
|---|---|---|---|
criticality | enum | yes | The criticality of the service function. Allowed: PRIMARY, SUPPLEMENTAL |
description | string | — | The description of the service function. |
name | string | yes | The name of the service function. |
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. |
serviceArn | string | yes | The ARN of the parent service. |
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. |
createdAt | string | — | The timestamp when the service function was created. |
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. |
resourceCount | integer | — | The number of resources associated with this function. |
serviceFunctionId | string | — | The server-generated service function ID. |
source | enum | — | The source of the service function. Allowed: AI_GENERATED, USER |
updatedAt | string | — | The timestamp when the service function was last updated. |
ResilienceHubV2System # CLOUD CONTROL · AWS::ResilienceHubV2::System
ResilienceHubV2System manages AWS::ResilienceHubV2::System through the AWS Cloud Control API.
kubectl get resiliencehubv2systems · example on GitHub
Example
# ResilienceHubV2System — Resilience Hub v2
# 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/resiliencehubv2.html#resiliencehubv2system
apiVersion: aws.konfig.io/v1alpha1
kind: ResilienceHubV2System
metadata:
name: example-resiliencehubv2system
namespace: default
spec:
description: Managed by konfig-konector
kmsKeyId: arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
name: example-resiliencehubv2system
providerRef:
name: example-resiliencehubv2system
region: us-east-1
sharingEnabled: true
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
description | string | — | The description of the system. |
kmsKeyId | string | — | The KMS key ID for encrypting system data. |
name | string | yes | The name of the system. |
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. |
sharingEnabled | boolean | — | Whether the system is enabled to be shared with other members of the Organization. |
tags | array<object> | — | Tags assigned to the system. |
tags[].key | string | yes | |
tags[].value | string | yes |
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. |
createdAt | string | — | The timestamp when the system was created. |
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. |
systemArn | string | — | The ARN of the system. |
systemId | string | — | The system ID. |
updatedAt | string | — | The timestamp when the system was last updated. |
ResilienceHubV2UserJourney # CLOUD CONTROL · AWS::ResilienceHubV2::UserJourney
ResilienceHubV2UserJourney manages AWS::ResilienceHubV2::UserJourney through the AWS Cloud Control API.
kubectl get resiliencehubv2userjourneys · example on GitHub
Example
# ResilienceHubV2UserJourney — Resilience Hub v2
# 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/resiliencehubv2.html#resiliencehubv2userjourney
apiVersion: aws.konfig.io/v1alpha1
kind: ResilienceHubV2UserJourney
metadata:
name: example-resiliencehubv2userjourney
namespace: default
spec:
description: Managed by konfig-konector
name: example-resiliencehubv2userjourney
policyArn: arn:aws:iam::123456789012:role/example-role
providerRef:
name: example-resiliencehubv2userjourney
region: us-east-1
systemIdentifier: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
description | string | — | The description of the user journey. |
name | string | yes | The name of the user journey. |
policyArn | string | — | The ARN of the resilience policy to associate with this user journey. |
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. |
systemIdentifier | string | yes | The system ARN or system ID that owns this user journey. |
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. |
createdAt | string | — | The timestamp when the user journey was created. |
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. |
updatedAt | string | — | The timestamp when the user journey was last updated. |
userJourneyId | string | — | The server-generated user journey ID. |