Backup

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

API Group: aws.konfig.io/v1alpha1

BackupFramework # CLOUD CONTROL · AWS::Backup::Framework

BackupFramework manages AWS::Backup::Framework through the AWS Cloud Control API.

kubectl get backupframeworks · example on GitHub

Example

# BackupFramework — Backup
# 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/backup.html#backupframework
apiVersion: aws.konfig.io/v1alpha1
kind: BackupFramework
metadata:
  name: example-backupframework
  namespace: default
spec:
  frameworkControls:
  - controlInputParameters:
    - parameterName: example-backupframework
      parameterValue: example
    controlName: example-backupframework
    controlScope:
      complianceResourceIds:
      - example
      complianceResourceTypes:
      - example
      tags:
      - key: example
        value: example
  frameworkDescription: Managed by konfig-konector
  frameworkName: example-backupframework
  frameworkTags:
  - key: example
    value: example
  providerRef:
    name: example-backupframework
    region: us-east-1

Spec

FieldTypeRequiredDescription
frameworkControlsarray<object>yesContains detailed information about all of the controls of a framework.
frameworkControls[].controlInputParametersarray<object>—A list of ParameterName and ParameterValue pairs.
frameworkControls[].controlInputParameters[].parameterNamestringyes
frameworkControls[].controlInputParameters[].parameterValuestringyes
frameworkControls[].controlNamestringyesThe name of a control.
frameworkControls[].controlScopeobject—The scope of a control.
frameworkControls[].controlScope.complianceResourceIdsarray<string>—The ID of the only AWS resource that you want your control scope to contain.
frameworkControls[].controlScope.complianceResourceTypesarray<string>—Describes whether the control scope includes one or more types of resources, such as `EFS` or `RDS`.
frameworkControls[].controlScope.tagsarray<object>—Describes whether the control scope includes resources with one or more tags.
frameworkControls[].controlScope.tags[].keystringyes
frameworkControls[].controlScope.tags[].valuestringyes
frameworkDescriptionstring—An optional description of the framework with a maximum 1,024 characters.
frameworkNamestring—The unique name of a framework.
frameworkTagsarray<object>—Metadata that you can assign to help organize the frameworks that you create.
frameworkTags[].keystringyes
frameworkTags[].valuestringyes
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.

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.
creationTimestring—The date and time that a framework is created, in ISO 8601 representation.
deploymentStatusstring—The deployment status of a framework.
frameworkArnstring—An Amazon Resource Name (ARN) that uniquely identifies Framework as a resource Read-only: reported by AWS after creation.
frameworkStatusstring—A framework consists of one or more controls.
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.

BackupLegalHold # CLOUD CONTROL · AWS::Backup::LegalHold

BackupLegalHold manages AWS::Backup::LegalHold through the AWS Cloud Control API.

kubectl get backuplegalholds · example on GitHub

Example

# BackupLegalHold — Backup
# 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/backup.html#backuplegalhold
apiVersion: aws.konfig.io/v1alpha1
kind: BackupLegalHold
metadata:
  name: example-backuplegalhold
  namespace: default
spec:
  description: Managed by konfig-konector
  providerRef:
    name: example-backuplegalhold
    region: us-east-1
  recoveryPointSelection:
    dateRange:
      fromDate: example
      toDate: example
    resourceIdentifiers:
    - example
    vaultNames:
    - example
  tags:
  - key: example
    value: example
  title: example

Spec

FieldTypeRequiredDescription
descriptionstringyesThe description of the legal hold.
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.
recoveryPointSelectionobjectyesThe criteria to assign a set of resources, such as resource types or backup vaults.
recoveryPointSelection.dateRangeobject—A date range for filtering recovery points.
recoveryPointSelection.dateRange.fromDatestringyesThe beginning date, inclusive.
recoveryPointSelection.dateRange.toDatestringyesThe end date, inclusive.
recoveryPointSelection.resourceIdentifiersarray<string>—The resources included in the resource selection.
recoveryPointSelection.vaultNamesarray<string>—The names of the vaults in which the selected recovery points are contained.
tagsarray<object>—Optional tags to include.
tags[].keystringyesThe key name of the tag.
tags[].valuestringyesThe value for the tag.
titlestringyesThe title of the legal hold.

Status

FieldTypeRequiredDescription
arnstring—The Amazon Resource Name (ARN) of the legal hold.
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.
creationDatestring—The time when the legal hold was created.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
legalHoldIdstring—The ID of the legal hold.
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.
statusenum—The status of the legal hold. Allowed: CREATING, ACTIVE, CANCELING, CANCELED

BackupLogicallyAirGappedBackupVault # CLOUD CONTROL · AWS::Backup::LogicallyAirGappedBackupVault

BackupLogicallyAirGappedBackupVault manages AWS::Backup::LogicallyAirGappedBackupVault through the AWS Cloud Control API.

kubectl get backuplogicallyairgappedbackupvaults · example on GitHub

Example

# BackupLogicallyAirGappedBackupVault — Backup
# 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/backup.html#backuplogicallyairgappedbackupvault
apiVersion: aws.konfig.io/v1alpha1
kind: BackupLogicallyAirGappedBackupVault
metadata:
  name: example-backuplogicallyairgappedbackupvault
  namespace: default
spec:
  backupVaultName: example-backuplogicallyairgappedbackupvault
  backupVaultTags:
    environment: dev
    team: platform
  encryptionKeyArn: arn:aws:iam::123456789012:role/example-role
  maxRetentionDays: 7
  minRetentionDays: 7
  mpaApprovalTeamArn: arn:aws:iam::123456789012:role/example-role
  notifications:
    backupVaultEvents:
    - example
    snsTopicArn: arn:aws:iam::123456789012:role/example-role
  providerRef:
    name: example-backuplogicallyairgappedbackupvault
    region: us-east-1

Spec

FieldTypeRequiredDescription
accessPolicyobject—
backupVaultNamestringyesCreate-only in AWS: changing it requires replacing the resource.
backupVaultTagsmap<string>—
encryptionKeyArnstring—Create-only in AWS: changing it requires replacing the resource.
maxRetentionDaysintegeryesCreate-only in AWS: changing it requires replacing the resource.
minRetentionDaysintegeryesCreate-only in AWS: changing it requires replacing the resource.
mpaApprovalTeamArnstring—
notificationsobject—BackupLogicallyAirGappedBackupVaultNotificationObjectType is a nested property type of AWS::Backup::LogicallyAirGappedBackupVault.
notifications.backupVaultEventsarray<string>yes
notifications.snsTopicArnstringyes
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.

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).
backupVaultArnstring—Read-only: reported by AWS after creation.
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.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
vaultStatestring—Read-only: reported by AWS after creation.
vaultTypestring—Read-only: reported by AWS after creation.

BackupPlan # GA

BackupPlan is the Schema for managing AWS Backup plans.

kubectl get backupplans · example on GitHub

Example

# BackupPlan — Backup
# 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/backup.html#backupplan
apiVersion: aws.konfig.io/v1alpha1
kind: BackupPlan
metadata:
  name: example-backupplan
  namespace: default
spec:
  planName: example-backupplan
  providerRef:
    name: example-backupplan
    region: us-east-1
  rules:
  - completionWindowMinutes: 1
    lifecycle:
      deleteAfterDays: 7
      moveToColdStorageAfterDays: 7
    ruleName: example-backupplan
    scheduleExpression: example
    startWindowMinutes: 1
    targetBackupVaultName: example-backupplan
    targetBackupVaultRef: example
  tags:
    environment: dev
    team: platform

Spec

FieldTypeRequiredDescription
planNamestringyesPlanName is the display name of the backup plan.
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.
rulesarray<object>yesRules are the scheduled backup tasks in this plan.
rules[].completionWindowMinutesinteger—CompletionWindowMinutes is the window after a backup job starts before it must complete or be canceled.
rules[].lifecycleobject—Lifecycle defines cold storage transition and expiry for recovery points.
rules[].lifecycle.deleteAfterDaysinteger—DeleteAfterDays is the number of days after creation that a recovery point is deleted.
rules[].lifecycle.moveToColdStorageAfterDaysinteger—MoveToColdStorageAfterDays is the number of days after creation that a recovery point is moved to cold storage.
rules[].ruleNamestringyesRuleName is a display name for the rule.
rules[].scheduleExpressionstring—ScheduleExpression is a CRON expression in UTC specifying when Backup initiates a backup job.
rules[].startWindowMinutesinteger—StartWindowMinutes is the window after a backup is scheduled before a job is canceled if it doesn't start.
rules[].targetBackupVaultNamestring—TargetBackupVaultName is the AWS name of the vault where backups are stored.
rules[].targetBackupVaultRefstring—TargetBackupVaultRef references a BackupVault CR in the same namespace.
tagsmap<string>—Tags are AWS resource tags to apply to the plan.

Status

FieldTypeRequiredDescription
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.
lastSyncTimestring—LastSyncTime is when the resource was last successfully reconciled.
observedGenerationinteger—ObservedGeneration is the most recent .metadata.generation reconciled.
planArnstring—PlanARN is the ARN of the backup plan.
planIdstring—PlanID uniquely identifies the backup plan.
versionIdstring—VersionID is the current version of the backup plan.

BackupReportPlan # CLOUD CONTROL · AWS::Backup::ReportPlan

BackupReportPlan manages AWS::Backup::ReportPlan through the AWS Cloud Control API.

kubectl get backupreportplans · example on GitHub

Example

# BackupReportPlan — Backup
# 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/backup.html#backupreportplan
apiVersion: aws.konfig.io/v1alpha1
kind: BackupReportPlan
metadata:
  name: example-backupreportplan
  namespace: default
spec:
  providerRef:
    name: example-backupreportplan
    region: us-east-1
  reportDeliveryChannel:
    formats:
    - example
    s3BucketName: example-backupreportplan
    s3KeyPrefix: example
  reportPlanDescription: Managed by konfig-konector
  reportPlanName: example-backupreportplan
  reportPlanTags:
  - key: example
    value: example
  reportSetting:
    accounts:
    - example
    frameworkArns:
    - example
    organizationUnits:
    - example
    regions:
    - example
    reportTemplate: example

Spec

FieldTypeRequiredDescription
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.
reportDeliveryChannelobjectyesA structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
reportDeliveryChannel.formatsarray<string>—A list of the format of your reports: CSV, JSON, or both.
reportDeliveryChannel.s3BucketNamestringyesThe unique name of the S3 bucket that receives your reports.
reportDeliveryChannel.s3KeyPrefixstring—The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3.
reportPlanDescriptionstring—An optional description of the report plan with a maximum of 1,024 characters.
reportPlanNamestring—The unique name of the report plan.
reportPlanTagsarray<object>—Metadata that you can assign to help organize the report plans that you create.
reportPlanTags[].keystringyes
reportPlanTags[].valuestringyes
reportSettingobjectyesIdentifies the report template for the report.
reportSetting.accountsarray<string>—The list of AWS accounts that a report covers.
reportSetting.frameworkArnsarray<string>—The Amazon Resource Names (ARNs) of the frameworks a report covers.
reportSetting.organizationUnitsarray<string>—The list of AWS organization units that a report covers.
reportSetting.regionsarray<string>—The list of AWS regions that a report covers.
reportSetting.reportTemplatestringyesIdentifies the report template for the report.

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.
reportPlanArnstring—An Amazon Resource Name (ARN) that uniquely identifies a resource.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.

BackupRestoreTestingPlan # CLOUD CONTROL · AWS::Backup::RestoreTestingPlan

BackupRestoreTestingPlan manages AWS::Backup::RestoreTestingPlan through the AWS Cloud Control API.

kubectl get backuprestoretestingplans · example on GitHub

Example

# BackupRestoreTestingPlan — Backup
# 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/backup.html#backuprestoretestingplan
apiVersion: aws.konfig.io/v1alpha1
kind: BackupRestoreTestingPlan
metadata:
  name: example-backuprestoretestingplan
  namespace: default
spec:
  providerRef:
    name: example-backuprestoretestingplan
    region: us-east-1
  recoveryPointSelection:
    algorithm: LATEST_WITHIN_WINDOW
    excludeVaults:
    - example
    includeVaults:
    - example
    recoveryPointTypes:
    - example
    selectionWindowDays: 7
  restoreTestingPlanName: example-backuprestoretestingplan
  scheduleExpression: example
  scheduleExpressionTimezone: example
  startWindowHours: 1
  tags:
  - key: example
    value: example

Spec

FieldTypeRequiredDescription
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.
recoveryPointSelectionobjectyesBackupRestoreTestingPlanRestoreTestingRecoveryPointSelection is a nested property type of AWS::Backup::RestoreTestingPlan.
recoveryPointSelection.algorithmenumyesAllowed: LATEST_WITHIN_WINDOW, RANDOM_WITHIN_WINDOW
recoveryPointSelection.excludeVaultsarray<string>—
recoveryPointSelection.includeVaultsarray<string>yes
recoveryPointSelection.recoveryPointTypesarray<string>yes
recoveryPointSelection.selectionWindowDaysinteger—
restoreTestingPlanNamestringyesCreate-only in AWS: changing it requires replacing the resource.
scheduleExpressionstringyes
scheduleExpressionTimezonestring—
startWindowHoursinteger—
tagsarray<object>—
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.
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.
restoreTestingPlanArnstring—Read-only: reported by AWS after creation.

BackupRestoreTestingSelection # CLOUD CONTROL · AWS::Backup::RestoreTestingSelection

BackupRestoreTestingSelection manages AWS::Backup::RestoreTestingSelection through the AWS Cloud Control API.

kubectl get backuprestoretestingselections · example on GitHub

Example

# BackupRestoreTestingSelection — Backup
# 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/backup.html#backuprestoretestingselection
apiVersion: aws.konfig.io/v1alpha1
kind: BackupRestoreTestingSelection
metadata:
  name: example-backuprestoretestingselection
  namespace: default
spec:
  iamRoleArn: arn:aws:iam::123456789012:role/example-role
  protectedResourceArns:
  - example
  protectedResourceConditions:
    stringEquals:
    - key: example
      value: example
    stringNotEquals:
    - key: example
      value: example
  protectedResourceType: example
  providerRef:
    name: example-backuprestoretestingselection
    region: us-east-1
  restoreMetadataOverrides:
    key: value
  restoreTestingPlanName: example-backuprestoretestingselection
  restoreTestingSelectionName: example-backuprestoretestingselection
  validationWindowHours: 1

Spec

FieldTypeRequiredDescription
iamRoleArnstringyes
protectedResourceArnsarray<string>—
protectedResourceConditionsobject—BackupRestoreTestingSelectionProtectedResourceConditions is a nested property type of AWS::Backup::RestoreTestingSelection.
protectedResourceConditions.stringEqualsarray<object>—
protectedResourceConditions.stringEquals[].keystringyes
protectedResourceConditions.stringEquals[].valuestringyes
protectedResourceConditions.stringNotEqualsarray<object>—
protectedResourceConditions.stringNotEquals[].keystringyes
protectedResourceConditions.stringNotEquals[].valuestringyes
protectedResourceTypestringyesCreate-only in AWS: changing it requires replacing the resource.
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.
restoreMetadataOverridesmap<string>—
restoreTestingPlanNamestringyesCreate-only in AWS: changing it requires replacing the resource.
restoreTestingSelectionNamestringyesCreate-only in AWS: changing it requires replacing the resource.
validationWindowHoursinteger—

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.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.

BackupSelection # GA

BackupSelection is the Schema for managing AWS Backup selections.

kubectl get backupselections · example on GitHub

Example

# BackupSelection — Backup
# 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/backup.html#backupselection
apiVersion: aws.konfig.io/v1alpha1
kind: BackupSelection
metadata:
  name: example-backupselection
  namespace: default
spec:
  iamRoleArn: arn:aws:iam::123456789012:role/example-role
  iamRoleRef:
    name: example-iamrole
  listOfTags:
  - key: example
    value: example
  planRef: example
  providerRef:
    name: example-backupselection
    region: us-east-1
  resources:
  - example
  selectionName: example-backupselection

Spec

FieldTypeRequiredDescription
iamRoleArnstring—IAMRoleARN is the IAM role ARN Backup uses to authenticate when backing up resources.
iamRoleRefobject—IAMRoleRef references an IAMRole CR whose ARN to use.
iamRoleRef.arnstring—ARN is a direct AWS IAM role ARN.
iamRoleRef.namestring—Name of an IAMRole CR in the same namespace.
iamRoleRef.namespacestring—Namespace of the IAMRole CR.
listOfTagsarray<object>—ListOfTags assigns resources matching any of these StringEquals tag conditions (OR logic).
listOfTags[].keystringyesKey is the tag key.
listOfTags[].valuestringyesValue is the tag value.
planRefstringyesPlanRef is the name of a BackupPlan CR in the same namespace.
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.
resourcesarray<string>—Resources are ARNs of resources to assign to the backup plan.
selectionNamestringyesSelectionName is the display name of the resource selection.

Status

FieldTypeRequiredDescription
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.
lastSyncTimestring—LastSyncTime is when the resource was last successfully reconciled.
observedGenerationinteger—ObservedGeneration is the most recent .metadata.generation reconciled.
planIdstring—PlanID is the backup plan the selection is attached to.
selectionIdstring—SelectionID uniquely identifies the backup selection.

BackupTieringConfiguration # CLOUD CONTROL · AWS::Backup::TieringConfiguration

BackupTieringConfiguration manages AWS::Backup::TieringConfiguration through the AWS Cloud Control API.

kubectl get backuptieringconfigurations · example on GitHub

Example

# BackupTieringConfiguration — Backup
# 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/backup.html#backuptieringconfiguration
apiVersion: aws.konfig.io/v1alpha1
kind: BackupTieringConfiguration
metadata:
  name: example-backuptieringconfiguration
  namespace: default
spec:
  backupVaultName: example-backuptieringconfiguration
  providerRef:
    name: example-backuptieringconfiguration
    region: us-east-1
  resourceSelection:
  - resourceType: example
    resources:
    - example
    tieringDownSettingsInDays: 7
  tieringConfigurationName: example-backuptieringconfiguration
  tieringConfigurationTags:
    environment: dev
    team: platform

Spec

FieldTypeRequiredDescription
backupVaultNamestringyes
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.
resourceSelectionarray<object>yes
resourceSelection[].resourceTypestringyes
resourceSelection[].resourcesarray<string>yes
resourceSelection[].tieringDownSettingsInDaysintegeryes
tieringConfigurationNamestringyesCreate-only in AWS: changing it requires replacing the resource.
tieringConfigurationTagsmap<string>—

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.
creationTimestring—Read-only: reported by AWS after creation.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
lastUpdatedTimestring—Read-only: reported by AWS after creation.
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.
tieringConfigurationArnstring—Read-only: reported by AWS after creation.

BackupVault # GA

BackupVault is the Schema for managing AWS Backup vaults.

kubectl get backupvaults · example on GitHub

Example

# BackupVault — Backup
# 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/backup.html#backupvault
apiVersion: aws.konfig.io/v1alpha1
kind: BackupVault
metadata:
  name: example-backupvault
  namespace: default
spec:
  kmsKeyArn: arn:aws:iam::123456789012:role/example-role
  providerRef:
    name: example-backupvault
    region: us-east-1
  tags:
    environment: dev
    team: platform
  vaultName: example-backupvault

Spec

FieldTypeRequiredDescription
kmsKeyArnstring—KMSKeyARN is the server-side encryption key used to protect backups.
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>—Tags are AWS resource tags to apply to the vault.
vaultNamestringyesVaultName is the name of the backup vault.

Status

FieldTypeRequiredDescription
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.
lastSyncTimestring—LastSyncTime is when the resource was last successfully reconciled.
observedGenerationinteger—ObservedGeneration is the most recent .metadata.generation reconciled.
vaultArnstring—VaultARN is the ARN of the backup vault.