Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. gkebackup
  5. gkebackup/v1
  6. Backup

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.gkebackup/v1.Backup

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Creates a Backup for the given BackupPlan. Auto-naming is currently not supported for this resource.

Create Backup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Backup(name: string, args: BackupArgs, opts?: CustomResourceOptions);
@overload
def Backup(resource_name: str,
           args: BackupArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Backup(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           backup_plan_id: Optional[str] = None,
           backup_id: Optional[str] = None,
           delete_lock_days: Optional[int] = None,
           description: Optional[str] = None,
           labels: Optional[Mapping[str, str]] = None,
           location: Optional[str] = None,
           project: Optional[str] = None,
           retain_days: Optional[int] = None)
func NewBackup(ctx *Context, name string, args BackupArgs, opts ...ResourceOption) (*Backup, error)
public Backup(string name, BackupArgs args, CustomResourceOptions? opts = null)
public Backup(String name, BackupArgs args)
public Backup(String name, BackupArgs args, CustomResourceOptions options)

type: google-native:gkebackup/v1:Backup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. BackupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. BackupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. BackupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. BackupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. BackupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var examplebackupResourceResourceFromGkebackupv1 = new GoogleNative.Gkebackup.V1.Backup("examplebackupResourceResourceFromGkebackupv1", new()
{
    BackupPlanId = "string",
    BackupId = "string",
    DeleteLockDays = 0,
    Description = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Location = "string",
    Project = "string",
    RetainDays = 0,
});
Copy
example, err := gkebackup.NewBackup(ctx, "examplebackupResourceResourceFromGkebackupv1", &gkebackup.BackupArgs{
	BackupPlanId:   pulumi.String("string"),
	BackupId:       pulumi.String("string"),
	DeleteLockDays: pulumi.Int(0),
	Description:    pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Location:   pulumi.String("string"),
	Project:    pulumi.String("string"),
	RetainDays: pulumi.Int(0),
})
Copy
var examplebackupResourceResourceFromGkebackupv1 = new Backup("examplebackupResourceResourceFromGkebackupv1", BackupArgs.builder()
    .backupPlanId("string")
    .backupId("string")
    .deleteLockDays(0)
    .description("string")
    .labels(Map.of("string", "string"))
    .location("string")
    .project("string")
    .retainDays(0)
    .build());
Copy
examplebackup_resource_resource_from_gkebackupv1 = google_native.gkebackup.v1.Backup("examplebackupResourceResourceFromGkebackupv1",
    backup_plan_id="string",
    backup_id="string",
    delete_lock_days=0,
    description="string",
    labels={
        "string": "string",
    },
    location="string",
    project="string",
    retain_days=0)
Copy
const examplebackupResourceResourceFromGkebackupv1 = new google_native.gkebackup.v1.Backup("examplebackupResourceResourceFromGkebackupv1", {
    backupPlanId: "string",
    backupId: "string",
    deleteLockDays: 0,
    description: "string",
    labels: {
        string: "string",
    },
    location: "string",
    project: "string",
    retainDays: 0,
});
Copy
type: google-native:gkebackup/v1:Backup
properties:
    backupId: string
    backupPlanId: string
    deleteLockDays: 0
    description: string
    labels:
        string: string
    location: string
    project: string
    retainDays: 0
Copy

Backup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Backup resource accepts the following input properties:

BackupPlanId
This property is required.
Changes to this property will trigger replacement.
string
BackupId string
Optional. The client-provided short name for the Backup resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of Backups in this BackupPlan
DeleteLockDays int
Optional. Minimum age for this Backup (in days). If this field is set to a non-zero value, the Backup will be "locked" against deletion (either manual or automatic deletion) for the number of days provided (measured from the creation time of the Backup). MUST be an integer value between 0-90 (inclusive). Defaults to parent BackupPlan's backup_delete_lock_days setting and may only be increased (either at creation time or in a subsequent update).
Description string
Optional. User specified descriptive string for this Backup.
Labels Dictionary<string, string>
Optional. A set of custom labels supplied by user.
Location Changes to this property will trigger replacement. string
Project Changes to this property will trigger replacement. string
RetainDays int
Optional. The age (in days) after which this Backup will be automatically deleted. Must be an integer value >= 0: - If 0, no automatic deletion will occur for this Backup. - If not 0, this must be >= delete_lock_days and <= 365. Once a Backup is created, this value may only be increased. Defaults to the parent BackupPlan's backup_retain_days value.
BackupPlanId
This property is required.
Changes to this property will trigger replacement.
string
BackupId string
Optional. The client-provided short name for the Backup resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of Backups in this BackupPlan
DeleteLockDays int
Optional. Minimum age for this Backup (in days). If this field is set to a non-zero value, the Backup will be "locked" against deletion (either manual or automatic deletion) for the number of days provided (measured from the creation time of the Backup). MUST be an integer value between 0-90 (inclusive). Defaults to parent BackupPlan's backup_delete_lock_days setting and may only be increased (either at creation time or in a subsequent update).
Description string
Optional. User specified descriptive string for this Backup.
Labels map[string]string
Optional. A set of custom labels supplied by user.
Location Changes to this property will trigger replacement. string
Project Changes to this property will trigger replacement. string
RetainDays int
Optional. The age (in days) after which this Backup will be automatically deleted. Must be an integer value >= 0: - If 0, no automatic deletion will occur for this Backup. - If not 0, this must be >= delete_lock_days and <= 365. Once a Backup is created, this value may only be increased. Defaults to the parent BackupPlan's backup_retain_days value.
backupPlanId
This property is required.
Changes to this property will trigger replacement.
String
backupId String
Optional. The client-provided short name for the Backup resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of Backups in this BackupPlan
deleteLockDays Integer
Optional. Minimum age for this Backup (in days). If this field is set to a non-zero value, the Backup will be "locked" against deletion (either manual or automatic deletion) for the number of days provided (measured from the creation time of the Backup). MUST be an integer value between 0-90 (inclusive). Defaults to parent BackupPlan's backup_delete_lock_days setting and may only be increased (either at creation time or in a subsequent update).
description String
Optional. User specified descriptive string for this Backup.
labels Map<String,String>
Optional. A set of custom labels supplied by user.
location Changes to this property will trigger replacement. String
project Changes to this property will trigger replacement. String
retainDays Integer
Optional. The age (in days) after which this Backup will be automatically deleted. Must be an integer value >= 0: - If 0, no automatic deletion will occur for this Backup. - If not 0, this must be >= delete_lock_days and <= 365. Once a Backup is created, this value may only be increased. Defaults to the parent BackupPlan's backup_retain_days value.
backupPlanId
This property is required.
Changes to this property will trigger replacement.
string
backupId string
Optional. The client-provided short name for the Backup resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of Backups in this BackupPlan
deleteLockDays number
Optional. Minimum age for this Backup (in days). If this field is set to a non-zero value, the Backup will be "locked" against deletion (either manual or automatic deletion) for the number of days provided (measured from the creation time of the Backup). MUST be an integer value between 0-90 (inclusive). Defaults to parent BackupPlan's backup_delete_lock_days setting and may only be increased (either at creation time or in a subsequent update).
description string
Optional. User specified descriptive string for this Backup.
labels {[key: string]: string}
Optional. A set of custom labels supplied by user.
location Changes to this property will trigger replacement. string
project Changes to this property will trigger replacement. string
retainDays number
Optional. The age (in days) after which this Backup will be automatically deleted. Must be an integer value >= 0: - If 0, no automatic deletion will occur for this Backup. - If not 0, this must be >= delete_lock_days and <= 365. Once a Backup is created, this value may only be increased. Defaults to the parent BackupPlan's backup_retain_days value.
backup_plan_id
This property is required.
Changes to this property will trigger replacement.
str
backup_id str
Optional. The client-provided short name for the Backup resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of Backups in this BackupPlan
delete_lock_days int
Optional. Minimum age for this Backup (in days). If this field is set to a non-zero value, the Backup will be "locked" against deletion (either manual or automatic deletion) for the number of days provided (measured from the creation time of the Backup). MUST be an integer value between 0-90 (inclusive). Defaults to parent BackupPlan's backup_delete_lock_days setting and may only be increased (either at creation time or in a subsequent update).
description str
Optional. User specified descriptive string for this Backup.
labels Mapping[str, str]
Optional. A set of custom labels supplied by user.
location Changes to this property will trigger replacement. str
project Changes to this property will trigger replacement. str
retain_days int
Optional. The age (in days) after which this Backup will be automatically deleted. Must be an integer value >= 0: - If 0, no automatic deletion will occur for this Backup. - If not 0, this must be >= delete_lock_days and <= 365. Once a Backup is created, this value may only be increased. Defaults to the parent BackupPlan's backup_retain_days value.
backupPlanId
This property is required.
Changes to this property will trigger replacement.
String
backupId String
Optional. The client-provided short name for the Backup resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of Backups in this BackupPlan
deleteLockDays Number
Optional. Minimum age for this Backup (in days). If this field is set to a non-zero value, the Backup will be "locked" against deletion (either manual or automatic deletion) for the number of days provided (measured from the creation time of the Backup). MUST be an integer value between 0-90 (inclusive). Defaults to parent BackupPlan's backup_delete_lock_days setting and may only be increased (either at creation time or in a subsequent update).
description String
Optional. User specified descriptive string for this Backup.
labels Map<String>
Optional. A set of custom labels supplied by user.
location Changes to this property will trigger replacement. String
project Changes to this property will trigger replacement. String
retainDays Number
Optional. The age (in days) after which this Backup will be automatically deleted. Must be an integer value >= 0: - If 0, no automatic deletion will occur for this Backup. - If not 0, this must be >= delete_lock_days and <= 365. Once a Backup is created, this value may only be increased. Defaults to the parent BackupPlan's backup_retain_days value.

Outputs

All input properties are implicitly available as output properties. Additionally, the Backup resource produces the following output properties:

AllNamespaces bool
If True, all namespaces were included in the Backup.
ClusterMetadata Pulumi.GoogleNative.Gkebackup.V1.Outputs.ClusterMetadataResponse
Information about the GKE cluster from which this Backup was created.
CompleteTime string
Completion time of the Backup
ConfigBackupSizeBytes string
The size of the config backup in bytes.
ContainsSecrets bool
Whether or not the Backup contains Kubernetes Secrets. Controlled by the parent BackupPlan's include_secrets value.
ContainsVolumeData bool
Whether or not the Backup contains volume data. Controlled by the parent BackupPlan's include_volume_data value.
CreateTime string
The timestamp when this Backup resource was created.
DeleteLockExpireTime string
The time at which an existing delete lock will expire for this backup (calculated from create_time + delete_lock_days).
EncryptionKey Pulumi.GoogleNative.Gkebackup.V1.Outputs.EncryptionKeyResponse
The customer managed encryption key that was used to encrypt the Backup's artifacts. Inherited from the parent BackupPlan's encryption_key value.
Etag string
etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform backup updates in order to avoid race conditions: An etag is returned in the response to GetBackup, and systems are expected to put that etag in the request to UpdateBackup or DeleteBackup to ensure that their change will be applied to the same version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Manual bool
This flag indicates whether this Backup resource was created manually by a user or via a schedule in the BackupPlan. A value of True means that the Backup was created manually.
Name string
The fully qualified name of the Backup. projects/*/locations/*/backupPlans/*/backups/*
PodCount int
The total number of Kubernetes Pods contained in the Backup.
ResourceCount int
The total number of Kubernetes resources included in the Backup.
RetainExpireTime string
The time at which this Backup will be automatically deleted (calculated from create_time + retain_days).
SelectedApplications Pulumi.GoogleNative.Gkebackup.V1.Outputs.NamespacedNamesResponse
If set, the list of ProtectedApplications whose resources were included in the Backup.
SelectedNamespaces Pulumi.GoogleNative.Gkebackup.V1.Outputs.NamespacesResponse
If set, the list of namespaces that were included in the Backup.
SizeBytes string
The total size of the Backup in bytes = config backup size + sum(volume backup sizes)
State string
Current state of the Backup
StateReason string
Human-readable description of why the backup is in the current state.
Uid string
Server generated global unique identifier of UUID4
UpdateTime string
The timestamp when this Backup resource was last updated.
VolumeCount int
The total number of volume backups contained in the Backup.
AllNamespaces bool
If True, all namespaces were included in the Backup.
ClusterMetadata ClusterMetadataResponse
Information about the GKE cluster from which this Backup was created.
CompleteTime string
Completion time of the Backup
ConfigBackupSizeBytes string
The size of the config backup in bytes.
ContainsSecrets bool
Whether or not the Backup contains Kubernetes Secrets. Controlled by the parent BackupPlan's include_secrets value.
ContainsVolumeData bool
Whether or not the Backup contains volume data. Controlled by the parent BackupPlan's include_volume_data value.
CreateTime string
The timestamp when this Backup resource was created.
DeleteLockExpireTime string
The time at which an existing delete lock will expire for this backup (calculated from create_time + delete_lock_days).
EncryptionKey EncryptionKeyResponse
The customer managed encryption key that was used to encrypt the Backup's artifacts. Inherited from the parent BackupPlan's encryption_key value.
Etag string
etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform backup updates in order to avoid race conditions: An etag is returned in the response to GetBackup, and systems are expected to put that etag in the request to UpdateBackup or DeleteBackup to ensure that their change will be applied to the same version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Manual bool
This flag indicates whether this Backup resource was created manually by a user or via a schedule in the BackupPlan. A value of True means that the Backup was created manually.
Name string
The fully qualified name of the Backup. projects/*/locations/*/backupPlans/*/backups/*
PodCount int
The total number of Kubernetes Pods contained in the Backup.
ResourceCount int
The total number of Kubernetes resources included in the Backup.
RetainExpireTime string
The time at which this Backup will be automatically deleted (calculated from create_time + retain_days).
SelectedApplications NamespacedNamesResponse
If set, the list of ProtectedApplications whose resources were included in the Backup.
SelectedNamespaces NamespacesResponse
If set, the list of namespaces that were included in the Backup.
SizeBytes string
The total size of the Backup in bytes = config backup size + sum(volume backup sizes)
State string
Current state of the Backup
StateReason string
Human-readable description of why the backup is in the current state.
Uid string
Server generated global unique identifier of UUID4
UpdateTime string
The timestamp when this Backup resource was last updated.
VolumeCount int
The total number of volume backups contained in the Backup.
allNamespaces Boolean
If True, all namespaces were included in the Backup.
clusterMetadata ClusterMetadataResponse
Information about the GKE cluster from which this Backup was created.
completeTime String
Completion time of the Backup
configBackupSizeBytes String
The size of the config backup in bytes.
containsSecrets Boolean
Whether or not the Backup contains Kubernetes Secrets. Controlled by the parent BackupPlan's include_secrets value.
containsVolumeData Boolean
Whether or not the Backup contains volume data. Controlled by the parent BackupPlan's include_volume_data value.
createTime String
The timestamp when this Backup resource was created.
deleteLockExpireTime String
The time at which an existing delete lock will expire for this backup (calculated from create_time + delete_lock_days).
encryptionKey EncryptionKeyResponse
The customer managed encryption key that was used to encrypt the Backup's artifacts. Inherited from the parent BackupPlan's encryption_key value.
etag String
etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform backup updates in order to avoid race conditions: An etag is returned in the response to GetBackup, and systems are expected to put that etag in the request to UpdateBackup or DeleteBackup to ensure that their change will be applied to the same version of the resource.
id String
The provider-assigned unique ID for this managed resource.
manual Boolean
This flag indicates whether this Backup resource was created manually by a user or via a schedule in the BackupPlan. A value of True means that the Backup was created manually.
name String
The fully qualified name of the Backup. projects/*/locations/*/backupPlans/*/backups/*
podCount Integer
The total number of Kubernetes Pods contained in the Backup.
resourceCount Integer
The total number of Kubernetes resources included in the Backup.
retainExpireTime String
The time at which this Backup will be automatically deleted (calculated from create_time + retain_days).
selectedApplications NamespacedNamesResponse
If set, the list of ProtectedApplications whose resources were included in the Backup.
selectedNamespaces NamespacesResponse
If set, the list of namespaces that were included in the Backup.
sizeBytes String
The total size of the Backup in bytes = config backup size + sum(volume backup sizes)
state String
Current state of the Backup
stateReason String
Human-readable description of why the backup is in the current state.
uid String
Server generated global unique identifier of UUID4
updateTime String
The timestamp when this Backup resource was last updated.
volumeCount Integer
The total number of volume backups contained in the Backup.
allNamespaces boolean
If True, all namespaces were included in the Backup.
clusterMetadata ClusterMetadataResponse
Information about the GKE cluster from which this Backup was created.
completeTime string
Completion time of the Backup
configBackupSizeBytes string
The size of the config backup in bytes.
containsSecrets boolean
Whether or not the Backup contains Kubernetes Secrets. Controlled by the parent BackupPlan's include_secrets value.
containsVolumeData boolean
Whether or not the Backup contains volume data. Controlled by the parent BackupPlan's include_volume_data value.
createTime string
The timestamp when this Backup resource was created.
deleteLockExpireTime string
The time at which an existing delete lock will expire for this backup (calculated from create_time + delete_lock_days).
encryptionKey EncryptionKeyResponse
The customer managed encryption key that was used to encrypt the Backup's artifacts. Inherited from the parent BackupPlan's encryption_key value.
etag string
etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform backup updates in order to avoid race conditions: An etag is returned in the response to GetBackup, and systems are expected to put that etag in the request to UpdateBackup or DeleteBackup to ensure that their change will be applied to the same version of the resource.
id string
The provider-assigned unique ID for this managed resource.
manual boolean
This flag indicates whether this Backup resource was created manually by a user or via a schedule in the BackupPlan. A value of True means that the Backup was created manually.
name string
The fully qualified name of the Backup. projects/*/locations/*/backupPlans/*/backups/*
podCount number
The total number of Kubernetes Pods contained in the Backup.
resourceCount number
The total number of Kubernetes resources included in the Backup.
retainExpireTime string
The time at which this Backup will be automatically deleted (calculated from create_time + retain_days).
selectedApplications NamespacedNamesResponse
If set, the list of ProtectedApplications whose resources were included in the Backup.
selectedNamespaces NamespacesResponse
If set, the list of namespaces that were included in the Backup.
sizeBytes string
The total size of the Backup in bytes = config backup size + sum(volume backup sizes)
state string
Current state of the Backup
stateReason string
Human-readable description of why the backup is in the current state.
uid string
Server generated global unique identifier of UUID4
updateTime string
The timestamp when this Backup resource was last updated.
volumeCount number
The total number of volume backups contained in the Backup.
all_namespaces bool
If True, all namespaces were included in the Backup.
cluster_metadata ClusterMetadataResponse
Information about the GKE cluster from which this Backup was created.
complete_time str
Completion time of the Backup
config_backup_size_bytes str
The size of the config backup in bytes.
contains_secrets bool
Whether or not the Backup contains Kubernetes Secrets. Controlled by the parent BackupPlan's include_secrets value.
contains_volume_data bool
Whether or not the Backup contains volume data. Controlled by the parent BackupPlan's include_volume_data value.
create_time str
The timestamp when this Backup resource was created.
delete_lock_expire_time str
The time at which an existing delete lock will expire for this backup (calculated from create_time + delete_lock_days).
encryption_key EncryptionKeyResponse
The customer managed encryption key that was used to encrypt the Backup's artifacts. Inherited from the parent BackupPlan's encryption_key value.
etag str
etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform backup updates in order to avoid race conditions: An etag is returned in the response to GetBackup, and systems are expected to put that etag in the request to UpdateBackup or DeleteBackup to ensure that their change will be applied to the same version of the resource.
id str
The provider-assigned unique ID for this managed resource.
manual bool
This flag indicates whether this Backup resource was created manually by a user or via a schedule in the BackupPlan. A value of True means that the Backup was created manually.
name str
The fully qualified name of the Backup. projects/*/locations/*/backupPlans/*/backups/*
pod_count int
The total number of Kubernetes Pods contained in the Backup.
resource_count int
The total number of Kubernetes resources included in the Backup.
retain_expire_time str
The time at which this Backup will be automatically deleted (calculated from create_time + retain_days).
selected_applications NamespacedNamesResponse
If set, the list of ProtectedApplications whose resources were included in the Backup.
selected_namespaces NamespacesResponse
If set, the list of namespaces that were included in the Backup.
size_bytes str
The total size of the Backup in bytes = config backup size + sum(volume backup sizes)
state str
Current state of the Backup
state_reason str
Human-readable description of why the backup is in the current state.
uid str
Server generated global unique identifier of UUID4
update_time str
The timestamp when this Backup resource was last updated.
volume_count int
The total number of volume backups contained in the Backup.
allNamespaces Boolean
If True, all namespaces were included in the Backup.
clusterMetadata Property Map
Information about the GKE cluster from which this Backup was created.
completeTime String
Completion time of the Backup
configBackupSizeBytes String
The size of the config backup in bytes.
containsSecrets Boolean
Whether or not the Backup contains Kubernetes Secrets. Controlled by the parent BackupPlan's include_secrets value.
containsVolumeData Boolean
Whether or not the Backup contains volume data. Controlled by the parent BackupPlan's include_volume_data value.
createTime String
The timestamp when this Backup resource was created.
deleteLockExpireTime String
The time at which an existing delete lock will expire for this backup (calculated from create_time + delete_lock_days).
encryptionKey Property Map
The customer managed encryption key that was used to encrypt the Backup's artifacts. Inherited from the parent BackupPlan's encryption_key value.
etag String
etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform backup updates in order to avoid race conditions: An etag is returned in the response to GetBackup, and systems are expected to put that etag in the request to UpdateBackup or DeleteBackup to ensure that their change will be applied to the same version of the resource.
id String
The provider-assigned unique ID for this managed resource.
manual Boolean
This flag indicates whether this Backup resource was created manually by a user or via a schedule in the BackupPlan. A value of True means that the Backup was created manually.
name String
The fully qualified name of the Backup. projects/*/locations/*/backupPlans/*/backups/*
podCount Number
The total number of Kubernetes Pods contained in the Backup.
resourceCount Number
The total number of Kubernetes resources included in the Backup.
retainExpireTime String
The time at which this Backup will be automatically deleted (calculated from create_time + retain_days).
selectedApplications Property Map
If set, the list of ProtectedApplications whose resources were included in the Backup.
selectedNamespaces Property Map
If set, the list of namespaces that were included in the Backup.
sizeBytes String
The total size of the Backup in bytes = config backup size + sum(volume backup sizes)
state String
Current state of the Backup
stateReason String
Human-readable description of why the backup is in the current state.
uid String
Server generated global unique identifier of UUID4
updateTime String
The timestamp when this Backup resource was last updated.
volumeCount Number
The total number of volume backups contained in the Backup.

Supporting Types

ClusterMetadataResponse
, ClusterMetadataResponseArgs

AnthosVersion This property is required. string
Anthos version
BackupCrdVersions This property is required. Dictionary<string, string>
A list of the Backup for GKE CRD versions found in the cluster.
Cluster This property is required. string
The source cluster from which this Backup was created. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/* This is inherited from the parent BackupPlan's cluster field.
GkeVersion This property is required. string
GKE version
K8sVersion This property is required. string
The Kubernetes server version of the source cluster.
AnthosVersion This property is required. string
Anthos version
BackupCrdVersions This property is required. map[string]string
A list of the Backup for GKE CRD versions found in the cluster.
Cluster This property is required. string
The source cluster from which this Backup was created. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/* This is inherited from the parent BackupPlan's cluster field.
GkeVersion This property is required. string
GKE version
K8sVersion This property is required. string
The Kubernetes server version of the source cluster.
anthosVersion This property is required. String
Anthos version
backupCrdVersions This property is required. Map<String,String>
A list of the Backup for GKE CRD versions found in the cluster.
cluster This property is required. String
The source cluster from which this Backup was created. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/* This is inherited from the parent BackupPlan's cluster field.
gkeVersion This property is required. String
GKE version
k8sVersion This property is required. String
The Kubernetes server version of the source cluster.
anthosVersion This property is required. string
Anthos version
backupCrdVersions This property is required. {[key: string]: string}
A list of the Backup for GKE CRD versions found in the cluster.
cluster This property is required. string
The source cluster from which this Backup was created. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/* This is inherited from the parent BackupPlan's cluster field.
gkeVersion This property is required. string
GKE version
k8sVersion This property is required. string
The Kubernetes server version of the source cluster.
anthos_version This property is required. str
Anthos version
backup_crd_versions This property is required. Mapping[str, str]
A list of the Backup for GKE CRD versions found in the cluster.
cluster This property is required. str
The source cluster from which this Backup was created. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/* This is inherited from the parent BackupPlan's cluster field.
gke_version This property is required. str
GKE version
k8s_version This property is required. str
The Kubernetes server version of the source cluster.
anthosVersion This property is required. String
Anthos version
backupCrdVersions This property is required. Map<String>
A list of the Backup for GKE CRD versions found in the cluster.
cluster This property is required. String
The source cluster from which this Backup was created. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/* This is inherited from the parent BackupPlan's cluster field.
gkeVersion This property is required. String
GKE version
k8sVersion This property is required. String
The Kubernetes server version of the source cluster.

EncryptionKeyResponse
, EncryptionKeyResponseArgs

GcpKmsEncryptionKey This property is required. string
Optional. Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
GcpKmsEncryptionKey This property is required. string
Optional. Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
gcpKmsEncryptionKey This property is required. String
Optional. Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
gcpKmsEncryptionKey This property is required. string
Optional. Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
gcp_kms_encryption_key This property is required. str
Optional. Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
gcpKmsEncryptionKey This property is required. String
Optional. Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*

NamespacedNameResponse
, NamespacedNameResponseArgs

Name This property is required. string
Optional. The name of the Kubernetes resource.
Namespace This property is required. string
Optional. The Namespace of the Kubernetes resource.
Name This property is required. string
Optional. The name of the Kubernetes resource.
Namespace This property is required. string
Optional. The Namespace of the Kubernetes resource.
name This property is required. String
Optional. The name of the Kubernetes resource.
namespace This property is required. String
Optional. The Namespace of the Kubernetes resource.
name This property is required. string
Optional. The name of the Kubernetes resource.
namespace This property is required. string
Optional. The Namespace of the Kubernetes resource.
name This property is required. str
Optional. The name of the Kubernetes resource.
namespace This property is required. str
Optional. The Namespace of the Kubernetes resource.
name This property is required. String
Optional. The name of the Kubernetes resource.
namespace This property is required. String
Optional. The Namespace of the Kubernetes resource.

NamespacedNamesResponse
, NamespacedNamesResponseArgs

NamespacedNames This property is required. List<Pulumi.GoogleNative.Gkebackup.V1.Inputs.NamespacedNameResponse>
Optional. A list of namespaced Kubernetes resources.
NamespacedNames This property is required. []NamespacedNameResponse
Optional. A list of namespaced Kubernetes resources.
namespacedNames This property is required. List<NamespacedNameResponse>
Optional. A list of namespaced Kubernetes resources.
namespacedNames This property is required. NamespacedNameResponse[]
Optional. A list of namespaced Kubernetes resources.
namespaced_names This property is required. Sequence[NamespacedNameResponse]
Optional. A list of namespaced Kubernetes resources.
namespacedNames This property is required. List<Property Map>
Optional. A list of namespaced Kubernetes resources.

NamespacesResponse
, NamespacesResponseArgs

Namespaces This property is required. List<string>
Optional. A list of Kubernetes Namespaces
Namespaces This property is required. []string
Optional. A list of Kubernetes Namespaces
namespaces This property is required. List<String>
Optional. A list of Kubernetes Namespaces
namespaces This property is required. string[]
Optional. A list of Kubernetes Namespaces
namespaces This property is required. Sequence[str]
Optional. A list of Kubernetes Namespaces
namespaces This property is required. List<String>
Optional. A list of Kubernetes Namespaces

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native