You are viewing an outdated version of provider-aws-backup.Go to Latest
upbound/provider-aws-backup@v1.14.0
Framework
backup.aws.upbound.io
Framework
upbound/provider-aws-backup@v1.14.0backup.aws.upbound.io

Framework is the Schema for the Frameworks API. Provides an AWS Backup Framework resource.

Type

CRD

Group

backup.aws.upbound.io

Version

apiVersion: backup.aws.upbound.io/v1beta1

kind: Framework

API Documentation
apiVersion
string
kind
string
metadata
object
spec
object
object

FrameworkSpec defines the desired state of Framework

forProvider
requiredobject
requiredobject

No description provided.

control
array
array

One or more control blocks that make up the framework. Each control in the list has a name, input parameters, and scope. Detailed below.

array

One or more input parameter blocks. An example of a control with two parameters is: "backup plan frequency is at least daily and the retention period is at least 1 year". The first parameter is daily. The second parameter is 1 year. Detailed below.

name
string
value
string
name
string
scope
array
array

The scope of a control. The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans. Detailed below.

array

The ID of the only AWS resource that you want your control scope to contain. Minimum number of 1 item. Maximum number of 100 items.

array

Describes whether the control scope includes one or more types of resources, such as EFS or RDS.

tags
object
name
string
region
requiredstring
tags
object
object

THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.

control
array
array

One or more control blocks that make up the framework. Each control in the list has a name, input parameters, and scope. Detailed below.

array

One or more input parameter blocks. An example of a control with two parameters is: "backup plan frequency is at least daily and the retention period is at least 1 year". The first parameter is daily. The second parameter is 1 year. Detailed below.

name
string
value
string
name
string
scope
array
array

The scope of a control. The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans. Detailed below.

array

The ID of the only AWS resource that you want your control scope to contain. Minimum number of 1 item. Maximum number of 100 items.

array

Describes whether the control scope includes one or more types of resources, such as EFS or RDS.

tags
object
name
string
tags
object
array

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

configRef
object
object

SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
metadata
object
object

Metadata is the metadata for connection secret.

labels
object
type
string
name
requiredstring
object

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.

name
requiredstring
namespace
requiredstring
status
object
object

FrameworkStatus defines the observed state of Framework.

object

No description provided.

arn
string
control
array
array

One or more control blocks that make up the framework. Each control in the list has a name, input parameters, and scope. Detailed below.

array

One or more input parameter blocks. An example of a control with two parameters is: "backup plan frequency is at least daily and the retention period is at least 1 year". The first parameter is daily. The second parameter is 1 year. Detailed below.

name
string
value
string
name
string
scope
array
array

The scope of a control. The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans. Detailed below.

array

The ID of the only AWS resource that you want your control scope to contain. Minimum number of 1 item. Maximum number of 100 items.

array

Describes whether the control scope includes one or more types of resources, such as EFS or RDS.

tags
object
id
string
name
string
status
string
tags
object
tagsAll
object
array

Conditions of the resource.

lastTransitionTime
requiredstring
message
string
reason
requiredstring
status
requiredstring
type
requiredstring
Discover the building blocks for your internal cloud platform.
© 2024 Upbound, Inc.
Solutions