Resilience Hub v2

5 resource kinds. Generated from the operator's CRD schemas.

API Group: 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

FieldTypeRequiredDescription
availabilitySloobject—ResilienceHubV2PolicyAvailabilitySlo is a nested property type of AWS::ResilienceHubV2::Policy.
availabilitySlo.targetnumber—Availability target percentage.
dataRecoveryobject—ResilienceHubV2PolicyDataRecoveryTargets is a nested property type of AWS::ResilienceHubV2::Policy.
dataRecovery.timeBetweenBackupsInMinutesinteger—Time between backups in minutes.
descriptionstring—The description of the policy.
kmsKeyIdstring—The KMS key ID for encrypting policy data.
multiAzobject—ResilienceHubV2PolicyMultiAzTargets is a nested property type of AWS::ResilienceHubV2::Policy.
multiAz.disasterRecoveryApproachenum—Multi-AZ disaster recovery approach. Allowed: ACTIVE_ACTIVE, HOT_STANDBY, WARM_STANDBY, PILOT_LIGHT, BACKUP_AND_RESTORE
multiAz.rpoInMinutesinteger—Recovery Point Objective in minutes.
multiAz.rtoInMinutesinteger—Recovery Time Objective in minutes.
multiRegionobject—ResilienceHubV2PolicyMultiRegionTargets is a nested property type of AWS::ResilienceHubV2::Policy.
multiRegion.disasterRecoveryApproachenum—Multi-Region disaster recovery approach. Allowed: ACTIVE_ACTIVE, HOT_STANDBY, WARM_STANDBY, PILOT_LIGHT, BACKUP_AND_RESTORE
multiRegion.rpoInMinutesinteger—Recovery Point Objective in minutes.
multiRegion.rtoInMinutesinteger—Recovery Time Objective in minutes.
namestringyesThe name of the 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.
tagsarray<object>—Tags assigned to the policy.
tags[].keystringyes
tags[].valuestringyes

Status

FieldTypeRequiredDescription
associatedServiceCountinteger—The number of services associated with this policy.
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.
createdAtstring—The timestamp when the policy was created.
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—The ARN of the policy.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
updatedAtstring—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

FieldTypeRequiredDescription
assertionsarray<object>—Assertions associated with this service.
assertions[].textstringyesThe text of the assertion.
associatedSystemsarray<object>—Systems associated with this service.
associatedSystems[].systemArnstringyesThe system ARN.
associatedSystems[].userJourneyIdsarray<string>—User journey IDs associated with this system.
dependencyDiscoveryenum—Dependency discovery state. Allowed: ENABLED, DISABLED, INITIALIZING
descriptionstring—The description of the service.
inputSourcesarray<object>—Input sources for this service.
inputSources[].resourceConfigurationobjectyesResilienceHubV2ServiceResourceConfiguration is a nested property type of AWS::ResilienceHubV2::Service.
inputSources[].resourceConfiguration.cfnStackArnstring—ARN of a CloudFormation stack.
inputSources[].resourceConfiguration.designFileS3Urlstring—S3 URL of a design file.
inputSources[].resourceConfiguration.eksobject—ResilienceHubV2ServiceEksSource is a nested property type of AWS::ResilienceHubV2::Service.
inputSources[].resourceConfiguration.eks.clusterArnstringyesARN of the EKS cluster.
inputSources[].resourceConfiguration.eks.namespacesarray<string>yesEKS namespaces.
inputSources[].resourceConfiguration.resourceTagsarray<object>—Resource tags to discover resources.
inputSources[].resourceConfiguration.resourceTags[].keystringyesTag key.
inputSources[].resourceConfiguration.resourceTags[].valuesarray<string>yesTag values.
inputSources[].resourceConfiguration.tfStateFileUrlstring—URL of a Terraform state file.
kmsKeyIdstring—The KMS key ID for encrypting service data.
namestringyesThe name of the service.
permissionModelobject—ResilienceHubV2ServicePermissionModel is a nested property type of AWS::ResilienceHubV2::Service.
permissionModel.crossAccountRoleArnsarray<object>—Cross-account role ARNs.
permissionModel.crossAccountRoleArns[].crossAccountRoleArnstringyesARN of the cross-account IAM role.
permissionModel.crossAccountRoleArns[].externalIdstring—External ID for cross-account access.
permissionModel.invokerRoleNamestringyesName of the invoker IAM role.
policyArnstring—The ARN of the resilience policy to associate.
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.
regionsarray<string>yesAWS regions for the service.
reportConfigurationobject—ResilienceHubV2ServiceServiceReportConfiguration is a nested property type of AWS::ResilienceHubV2::Service.
reportConfiguration.reportOutputarray<object>yesOutput destinations for generated reports.
reportConfiguration.reportOutput[].s3object—ResilienceHubV2ServiceS3ReportOutputConfiguration is a nested property type of AWS::ResilienceHubV2::Service.
reportConfiguration.reportOutput[].s3.bucketOwnerstringyesAccount ID of the bucket owner.
reportConfiguration.reportOutput[].s3.bucketPathstringyesS3 bucket path where reports will be written.
tagsarray<object>—Tags assigned to the service.
tags[].keystringyes
tags[].valuestringyes

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.
createdAtstring—The timestamp when the service was created.
effectivePolicyValuesobject—Read-only: reported by AWS after creation.
effectivePolicyValues.availabilitySloobject—ResilienceHubV2ServiceSloSource is a nested property type of AWS::ResilienceHubV2::Service.
effectivePolicyValues.availabilitySlo.policyNamestring—
effectivePolicyValues.availabilitySlo.valuenumber—
effectivePolicyValues.multiAzDrApproachobject—ResilienceHubV2ServiceDisasterRecoverySource is a nested property type of AWS::ResilienceHubV2::Service.
effectivePolicyValues.multiAzDrApproach.policyNamestring—
effectivePolicyValues.multiAzDrApproach.valuestring—
effectivePolicyValues.multiAzRpoobject—ResilienceHubV2ServiceTargetSource is a nested property type of AWS::ResilienceHubV2::Service.
effectivePolicyValues.multiAzRpo.policyNamestring—
effectivePolicyValues.multiAzRpo.valueinteger—
effectivePolicyValues.multiAzRtoobject—ResilienceHubV2ServiceTargetSource is a nested property type of AWS::ResilienceHubV2::Service.
effectivePolicyValues.multiAzRto.policyNamestring—
effectivePolicyValues.multiAzRto.valueinteger—
effectivePolicyValues.multiRegionDrApproachobject—ResilienceHubV2ServiceDisasterRecoverySource is a nested property type of AWS::ResilienceHubV2::Service.
effectivePolicyValues.multiRegionDrApproach.policyNamestring—
effectivePolicyValues.multiRegionDrApproach.valuestring—
effectivePolicyValues.multiRegionRpoobject—ResilienceHubV2ServiceTargetSource is a nested property type of AWS::ResilienceHubV2::Service.
effectivePolicyValues.multiRegionRpo.policyNamestring—
effectivePolicyValues.multiRegionRpo.valueinteger—
effectivePolicyValues.multiRegionRtoobject—ResilienceHubV2ServiceTargetSource is a nested property type of AWS::ResilienceHubV2::Service.
effectivePolicyValues.multiRegionRto.policyNamestring—
effectivePolicyValues.multiRegionRto.valueinteger—
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.
serviceArnstring—The ARN of the service.
updatedAtstring—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

FieldTypeRequiredDescription
criticalityenumyesThe criticality of the service function. Allowed: PRIMARY, SUPPLEMENTAL
descriptionstring—The description of the service function.
namestringyesThe name of the service function.
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.
serviceArnstringyesThe ARN of the parent service.

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.
createdAtstring—The timestamp when the service function was created.
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.
resourceCountinteger—The number of resources associated with this function.
serviceFunctionIdstring—The server-generated service function ID.
sourceenum—The source of the service function. Allowed: AI_GENERATED, USER
updatedAtstring—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

FieldTypeRequiredDescription
descriptionstring—The description of the system.
kmsKeyIdstring—The KMS key ID for encrypting system data.
namestringyesThe name of the system.
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.
sharingEnabledboolean—Whether the system is enabled to be shared with other members of the Organization.
tagsarray<object>—Tags assigned to the system.
tags[].keystringyes
tags[].valuestringyes

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.
createdAtstring—The timestamp when the system was created.
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.
systemArnstring—The ARN of the system.
systemIdstring—The system ID.
updatedAtstring—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

FieldTypeRequiredDescription
descriptionstring—The description of the user journey.
namestringyesThe name of the user journey.
policyArnstring—The ARN of the resilience policy to associate with this user journey.
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.
systemIdentifierstringyesThe system ARN or system ID that owns this user journey.

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.
createdAtstring—The timestamp when the user journey was created.
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.
updatedAtstring—The timestamp when the user journey was last updated.
userJourneyIdstring—The server-generated user journey ID.