Google Native

v0.27.0 published on Friday, Oct 21, 2022 by Pulumi

BackupPlan

Creates a new BackupPlan in a given location. Auto-naming is currently not supported for this resource.

Create BackupPlan Resource

new BackupPlan(name: string, args: BackupPlanArgs, opts?: CustomResourceOptions);
@overload
def BackupPlan(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               backup_config: Optional[BackupConfigArgs] = None,
               backup_plan_id: Optional[str] = None,
               backup_schedule: Optional[ScheduleArgs] = None,
               cluster: Optional[str] = None,
               deactivated: Optional[bool] = None,
               description: Optional[str] = None,
               labels: Optional[Mapping[str, str]] = None,
               location: Optional[str] = None,
               project: Optional[str] = None,
               retention_policy: Optional[RetentionPolicyArgs] = None)
@overload
def BackupPlan(resource_name: str,
               args: BackupPlanArgs,
               opts: Optional[ResourceOptions] = None)
func NewBackupPlan(ctx *Context, name string, args BackupPlanArgs, opts ...ResourceOption) (*BackupPlan, error)
public BackupPlan(string name, BackupPlanArgs args, CustomResourceOptions? opts = null)
public BackupPlan(String name, BackupPlanArgs args)
public BackupPlan(String name, BackupPlanArgs args, CustomResourceOptions options)
type: google-native:gkebackup/v1:BackupPlan
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

BackupPlan Resource Properties

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

Inputs

The BackupPlan resource accepts the following input properties:

BackupPlanId string

Required. The client-provided short name for the BackupPlan 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 BackupPlans in this location

Cluster string

Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/*

BackupConfig Pulumi.GoogleNative.Gkebackup.V1.Inputs.BackupConfigArgs

Defines the configuration of Backups created via this BackupPlan.

BackupSchedule Pulumi.GoogleNative.Gkebackup.V1.Inputs.ScheduleArgs

Defines a schedule for automatic Backup creation via this BackupPlan.

Deactivated bool

This flag indicates whether this BackupPlan has been deactivated. Setting this field to True locks the BackupPlan such that no further updates will be allowed (except deletes), including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups). Default: False

Description string

User specified descriptive string for this BackupPlan.

Labels Dictionary<string, string>

A set of custom labels supplied by user.

Location string
Project string
RetentionPolicy Pulumi.GoogleNative.Gkebackup.V1.Inputs.RetentionPolicyArgs

RetentionPolicy governs lifecycle of Backups created under this plan.

BackupPlanId string

Required. The client-provided short name for the BackupPlan 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 BackupPlans in this location

Cluster string

Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/*

BackupConfig BackupConfigArgs

Defines the configuration of Backups created via this BackupPlan.

BackupSchedule ScheduleArgs

Defines a schedule for automatic Backup creation via this BackupPlan.

Deactivated bool

This flag indicates whether this BackupPlan has been deactivated. Setting this field to True locks the BackupPlan such that no further updates will be allowed (except deletes), including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups). Default: False

Description string

User specified descriptive string for this BackupPlan.

Labels map[string]string

A set of custom labels supplied by user.

Location string
Project string
RetentionPolicy RetentionPolicyArgs

RetentionPolicy governs lifecycle of Backups created under this plan.

backupPlanId String

Required. The client-provided short name for the BackupPlan 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 BackupPlans in this location

cluster String

Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/*

backupConfig BackupConfigArgs

Defines the configuration of Backups created via this BackupPlan.

backupSchedule ScheduleArgs

Defines a schedule for automatic Backup creation via this BackupPlan.

deactivated Boolean

This flag indicates whether this BackupPlan has been deactivated. Setting this field to True locks the BackupPlan such that no further updates will be allowed (except deletes), including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups). Default: False

description String

User specified descriptive string for this BackupPlan.

labels Map<String,String>

A set of custom labels supplied by user.

location String
project String
retentionPolicy RetentionPolicyArgs

RetentionPolicy governs lifecycle of Backups created under this plan.

backupPlanId string

Required. The client-provided short name for the BackupPlan 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 BackupPlans in this location

cluster string

Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/*

backupConfig BackupConfigArgs

Defines the configuration of Backups created via this BackupPlan.

backupSchedule ScheduleArgs

Defines a schedule for automatic Backup creation via this BackupPlan.

deactivated boolean

This flag indicates whether this BackupPlan has been deactivated. Setting this field to True locks the BackupPlan such that no further updates will be allowed (except deletes), including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups). Default: False

description string

User specified descriptive string for this BackupPlan.

labels {[key: string]: string}

A set of custom labels supplied by user.

location string
project string
retentionPolicy RetentionPolicyArgs

RetentionPolicy governs lifecycle of Backups created under this plan.

backup_plan_id str

Required. The client-provided short name for the BackupPlan 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 BackupPlans in this location

cluster str

Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/*

backup_config BackupConfigArgs

Defines the configuration of Backups created via this BackupPlan.

backup_schedule ScheduleArgs

Defines a schedule for automatic Backup creation via this BackupPlan.

deactivated bool

This flag indicates whether this BackupPlan has been deactivated. Setting this field to True locks the BackupPlan such that no further updates will be allowed (except deletes), including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups). Default: False

description str

User specified descriptive string for this BackupPlan.

labels Mapping[str, str]

A set of custom labels supplied by user.

location str
project str
retention_policy RetentionPolicyArgs

RetentionPolicy governs lifecycle of Backups created under this plan.

backupPlanId String

Required. The client-provided short name for the BackupPlan 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 BackupPlans in this location

cluster String

Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/*

backupConfig Property Map

Defines the configuration of Backups created via this BackupPlan.

backupSchedule Property Map

Defines a schedule for automatic Backup creation via this BackupPlan.

deactivated Boolean

This flag indicates whether this BackupPlan has been deactivated. Setting this field to True locks the BackupPlan such that no further updates will be allowed (except deletes), including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups). Default: False

description String

User specified descriptive string for this BackupPlan.

labels Map<String>

A set of custom labels supplied by user.

location String
project String
retentionPolicy Property Map

RetentionPolicy governs lifecycle of Backups created under this plan.

Outputs

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

CreateTime string

The timestamp when this BackupPlan resource was created.

Etag string

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup plan from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlan updates in order to avoid race conditions: An etag is returned in the response to GetBackupPlan, and systems are expected to put that etag in the request to UpdateBackupPlan or DeleteBackupPlan 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.

Name string

The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*

ProtectedPodCount int

The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.

Uid string

Server generated global unique identifier of UUID format.

UpdateTime string

The timestamp when this BackupPlan resource was last updated.

CreateTime string

The timestamp when this BackupPlan resource was created.

Etag string

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup plan from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlan updates in order to avoid race conditions: An etag is returned in the response to GetBackupPlan, and systems are expected to put that etag in the request to UpdateBackupPlan or DeleteBackupPlan 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.

Name string

The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*

ProtectedPodCount int

The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.

Uid string

Server generated global unique identifier of UUID format.

UpdateTime string

The timestamp when this BackupPlan resource was last updated.

createTime String

The timestamp when this BackupPlan resource was created.

etag String

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup plan from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlan updates in order to avoid race conditions: An etag is returned in the response to GetBackupPlan, and systems are expected to put that etag in the request to UpdateBackupPlan or DeleteBackupPlan 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.

name String

The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*

protectedPodCount Integer

The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.

uid String

Server generated global unique identifier of UUID format.

updateTime String

The timestamp when this BackupPlan resource was last updated.

createTime string

The timestamp when this BackupPlan resource was created.

etag string

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup plan from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlan updates in order to avoid race conditions: An etag is returned in the response to GetBackupPlan, and systems are expected to put that etag in the request to UpdateBackupPlan or DeleteBackupPlan 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.

name string

The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*

protectedPodCount number

The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.

uid string

Server generated global unique identifier of UUID format.

updateTime string

The timestamp when this BackupPlan resource was last updated.

create_time str

The timestamp when this BackupPlan resource was created.

etag str

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup plan from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlan updates in order to avoid race conditions: An etag is returned in the response to GetBackupPlan, and systems are expected to put that etag in the request to UpdateBackupPlan or DeleteBackupPlan 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.

name str

The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*

protected_pod_count int

The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.

uid str

Server generated global unique identifier of UUID format.

update_time str

The timestamp when this BackupPlan resource was last updated.

createTime String

The timestamp when this BackupPlan resource was created.

etag String

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup plan from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlan updates in order to avoid race conditions: An etag is returned in the response to GetBackupPlan, and systems are expected to put that etag in the request to UpdateBackupPlan or DeleteBackupPlan 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.

name String

The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*

protectedPodCount Number

The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.

uid String

Server generated global unique identifier of UUID format.

updateTime String

The timestamp when this BackupPlan resource was last updated.

Supporting Types

BackupConfig

AllNamespaces bool

If True, include all namespaced resources

EncryptionKey Pulumi.GoogleNative.Gkebackup.V1.Inputs.EncryptionKey

This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.

IncludeSecrets bool

This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False

IncludeVolumeData bool

This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False

SelectedApplications Pulumi.GoogleNative.Gkebackup.V1.Inputs.NamespacedNames

If set, include just the resources referenced by the listed ProtectedApplications.

SelectedNamespaces Pulumi.GoogleNative.Gkebackup.V1.Inputs.Namespaces

If set, include just the resources in the listed namespaces.

AllNamespaces bool

If True, include all namespaced resources

EncryptionKey EncryptionKey

This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.

IncludeSecrets bool

This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False

IncludeVolumeData bool

This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False

SelectedApplications NamespacedNames

If set, include just the resources referenced by the listed ProtectedApplications.

SelectedNamespaces Namespaces

If set, include just the resources in the listed namespaces.

allNamespaces Boolean

If True, include all namespaced resources

encryptionKey EncryptionKey

This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.

includeSecrets Boolean

This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False

includeVolumeData Boolean

This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False

selectedApplications NamespacedNames

If set, include just the resources referenced by the listed ProtectedApplications.

selectedNamespaces Namespaces

If set, include just the resources in the listed namespaces.

allNamespaces boolean

If True, include all namespaced resources

encryptionKey EncryptionKey

This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.

includeSecrets boolean

This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False

includeVolumeData boolean

This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False

selectedApplications NamespacedNames

If set, include just the resources referenced by the listed ProtectedApplications.

selectedNamespaces Namespaces

If set, include just the resources in the listed namespaces.

all_namespaces bool

If True, include all namespaced resources

encryption_key EncryptionKey

This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.

include_secrets bool

This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False

include_volume_data bool

This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False

selected_applications NamespacedNames

If set, include just the resources referenced by the listed ProtectedApplications.

selected_namespaces Namespaces

If set, include just the resources in the listed namespaces.

allNamespaces Boolean

If True, include all namespaced resources

encryptionKey Property Map

This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.

includeSecrets Boolean

This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False

includeVolumeData Boolean

This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False

selectedApplications Property Map

If set, include just the resources referenced by the listed ProtectedApplications.

selectedNamespaces Property Map

If set, include just the resources in the listed namespaces.

BackupConfigResponse

AllNamespaces bool

If True, include all namespaced resources

EncryptionKey Pulumi.GoogleNative.Gkebackup.V1.Inputs.EncryptionKeyResponse

This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.

IncludeSecrets bool

This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False

IncludeVolumeData bool

This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False

SelectedApplications Pulumi.GoogleNative.Gkebackup.V1.Inputs.NamespacedNamesResponse

If set, include just the resources referenced by the listed ProtectedApplications.

SelectedNamespaces Pulumi.GoogleNative.Gkebackup.V1.Inputs.NamespacesResponse

If set, include just the resources in the listed namespaces.

AllNamespaces bool

If True, include all namespaced resources

EncryptionKey EncryptionKeyResponse

This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.

IncludeSecrets bool

This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False

IncludeVolumeData bool

This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False

SelectedApplications NamespacedNamesResponse

If set, include just the resources referenced by the listed ProtectedApplications.

SelectedNamespaces NamespacesResponse

If set, include just the resources in the listed namespaces.

allNamespaces Boolean

If True, include all namespaced resources

encryptionKey EncryptionKeyResponse

This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.

includeSecrets Boolean

This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False

includeVolumeData Boolean

This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False

selectedApplications NamespacedNamesResponse

If set, include just the resources referenced by the listed ProtectedApplications.

selectedNamespaces NamespacesResponse

If set, include just the resources in the listed namespaces.

allNamespaces boolean

If True, include all namespaced resources

encryptionKey EncryptionKeyResponse

This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.

includeSecrets boolean

This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False

includeVolumeData boolean

This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False

selectedApplications NamespacedNamesResponse

If set, include just the resources referenced by the listed ProtectedApplications.

selectedNamespaces NamespacesResponse

If set, include just the resources in the listed namespaces.

all_namespaces bool

If True, include all namespaced resources

encryption_key EncryptionKeyResponse

This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.

include_secrets bool

This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False

include_volume_data bool

This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False

selected_applications NamespacedNamesResponse

If set, include just the resources referenced by the listed ProtectedApplications.

selected_namespaces NamespacesResponse

If set, include just the resources in the listed namespaces.

allNamespaces Boolean

If True, include all namespaced resources

encryptionKey Property Map

This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.

includeSecrets Boolean

This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False

includeVolumeData Boolean

This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False

selectedApplications Property Map

If set, include just the resources referenced by the listed ProtectedApplications.

selectedNamespaces Property Map

If set, include just the resources in the listed namespaces.

EncryptionKey

GcpKmsEncryptionKey string

Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*

GcpKmsEncryptionKey string

Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*

gcpKmsEncryptionKey String

Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*

gcpKmsEncryptionKey string

Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*

gcp_kms_encryption_key str

Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*

gcpKmsEncryptionKey String

Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*

EncryptionKeyResponse

GcpKmsEncryptionKey string

Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*

GcpKmsEncryptionKey string

Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*

gcpKmsEncryptionKey String

Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*

gcpKmsEncryptionKey string

Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*

gcp_kms_encryption_key str

Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*

gcpKmsEncryptionKey String

Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*

NamespacedName

Name string

The name of the Kubernetes resource.

Namespace string

The Namespace of the Kubernetes resource.

Name string

The name of the Kubernetes resource.

Namespace string

The Namespace of the Kubernetes resource.

name String

The name of the Kubernetes resource.

namespace String

The Namespace of the Kubernetes resource.

name string

The name of the Kubernetes resource.

namespace string

The Namespace of the Kubernetes resource.

name str

The name of the Kubernetes resource.

namespace str

The Namespace of the Kubernetes resource.

name String

The name of the Kubernetes resource.

namespace String

The Namespace of the Kubernetes resource.

NamespacedNameResponse

Name string

The name of the Kubernetes resource.

Namespace string

The Namespace of the Kubernetes resource.

Name string

The name of the Kubernetes resource.

Namespace string

The Namespace of the Kubernetes resource.

name String

The name of the Kubernetes resource.

namespace String

The Namespace of the Kubernetes resource.

name string

The name of the Kubernetes resource.

namespace string

The Namespace of the Kubernetes resource.

name str

The name of the Kubernetes resource.

namespace str

The Namespace of the Kubernetes resource.

name String

The name of the Kubernetes resource.

namespace String

The Namespace of the Kubernetes resource.

NamespacedNames

NamespacedNames []NamespacedName

A list of namespaced Kubernetes resources.

namespacedNames List<NamespacedName>

A list of namespaced Kubernetes resources.

namespacedNames NamespacedName[]

A list of namespaced Kubernetes resources.

namespaced_names Sequence[NamespacedName]

A list of namespaced Kubernetes resources.

namespacedNames List<Property Map>

A list of namespaced Kubernetes resources.

NamespacedNamesResponse

NamespacedNames []NamespacedNameResponse

A list of namespaced Kubernetes resources.

namespacedNames List<NamespacedNameResponse>

A list of namespaced Kubernetes resources.

namespacedNames NamespacedNameResponse[]

A list of namespaced Kubernetes resources.

namespaced_names Sequence[NamespacedNameResponse]

A list of namespaced Kubernetes resources.

namespacedNames List<Property Map>

A list of namespaced Kubernetes resources.

Namespaces

Namespaces List<string>

A list of Kubernetes Namespaces

Namespaces []string

A list of Kubernetes Namespaces

namespaces List<String>

A list of Kubernetes Namespaces

namespaces string[]

A list of Kubernetes Namespaces

namespaces Sequence[str]

A list of Kubernetes Namespaces

namespaces List<String>

A list of Kubernetes Namespaces

NamespacesResponse

Namespaces List<string>

A list of Kubernetes Namespaces

Namespaces []string

A list of Kubernetes Namespaces

namespaces List<String>

A list of Kubernetes Namespaces

namespaces string[]

A list of Kubernetes Namespaces

namespaces Sequence[str]

A list of Kubernetes Namespaces

namespaces List<String>

A list of Kubernetes Namespaces

RetentionPolicy

BackupDeleteLockDays int

Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup's (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value. Default: 0 (no delete blocking)

BackupRetainDays int

The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Updating this field does NOT affect existing Backups under it. Backups created AFTER a successful update will automatically pick up the new value. NOTE: backup_retain_days must be >= backup_delete_lock_days. If cron_schedule is defined, then this must be <= 360 * the creation interval. Default: 0 (no automatic deletion)

Locked bool

This flag denotes whether the retention policy of this BackupPlan is locked. If set to True, no further update is allowed on this policy, including the locked field itself. Default: False

BackupDeleteLockDays int

Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup's (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value. Default: 0 (no delete blocking)

BackupRetainDays int

The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Updating this field does NOT affect existing Backups under it. Backups created AFTER a successful update will automatically pick up the new value. NOTE: backup_retain_days must be >= backup_delete_lock_days. If cron_schedule is defined, then this must be <= 360 * the creation interval. Default: 0 (no automatic deletion)

Locked bool

This flag denotes whether the retention policy of this BackupPlan is locked. If set to True, no further update is allowed on this policy, including the locked field itself. Default: False

backupDeleteLockDays Integer

Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup's (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value. Default: 0 (no delete blocking)

backupRetainDays Integer

The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Updating this field does NOT affect existing Backups under it. Backups created AFTER a successful update will automatically pick up the new value. NOTE: backup_retain_days must be >= backup_delete_lock_days. If cron_schedule is defined, then this must be <= 360 * the creation interval. Default: 0 (no automatic deletion)

locked Boolean

This flag denotes whether the retention policy of this BackupPlan is locked. If set to True, no further update is allowed on this policy, including the locked field itself. Default: False

backupDeleteLockDays number

Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup's (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value. Default: 0 (no delete blocking)

backupRetainDays number

The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Updating this field does NOT affect existing Backups under it. Backups created AFTER a successful update will automatically pick up the new value. NOTE: backup_retain_days must be >= backup_delete_lock_days. If cron_schedule is defined, then this must be <= 360 * the creation interval. Default: 0 (no automatic deletion)

locked boolean

This flag denotes whether the retention policy of this BackupPlan is locked. If set to True, no further update is allowed on this policy, including the locked field itself. Default: False

backup_delete_lock_days int

Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup's (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value. Default: 0 (no delete blocking)

backup_retain_days int

The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Updating this field does NOT affect existing Backups under it. Backups created AFTER a successful update will automatically pick up the new value. NOTE: backup_retain_days must be >= backup_delete_lock_days. If cron_schedule is defined, then this must be <= 360 * the creation interval. Default: 0 (no automatic deletion)

locked bool

This flag denotes whether the retention policy of this BackupPlan is locked. If set to True, no further update is allowed on this policy, including the locked field itself. Default: False

backupDeleteLockDays Number

Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup's (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value. Default: 0 (no delete blocking)

backupRetainDays Number

The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Updating this field does NOT affect existing Backups under it. Backups created AFTER a successful update will automatically pick up the new value. NOTE: backup_retain_days must be >= backup_delete_lock_days. If cron_schedule is defined, then this must be <= 360 * the creation interval. Default: 0 (no automatic deletion)

locked Boolean

This flag denotes whether the retention policy of this BackupPlan is locked. If set to True, no further update is allowed on this policy, including the locked field itself. Default: False

RetentionPolicyResponse

BackupDeleteLockDays int

Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup's (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value. Default: 0 (no delete blocking)

BackupRetainDays int

The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Updating this field does NOT affect existing Backups under it. Backups created AFTER a successful update will automatically pick up the new value. NOTE: backup_retain_days must be >= backup_delete_lock_days. If cron_schedule is defined, then this must be <= 360 * the creation interval. Default: 0 (no automatic deletion)

Locked bool

This flag denotes whether the retention policy of this BackupPlan is locked. If set to True, no further update is allowed on this policy, including the locked field itself. Default: False

BackupDeleteLockDays int

Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup's (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value. Default: 0 (no delete blocking)

BackupRetainDays int

The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Updating this field does NOT affect existing Backups under it. Backups created AFTER a successful update will automatically pick up the new value. NOTE: backup_retain_days must be >= backup_delete_lock_days. If cron_schedule is defined, then this must be <= 360 * the creation interval. Default: 0 (no automatic deletion)

Locked bool

This flag denotes whether the retention policy of this BackupPlan is locked. If set to True, no further update is allowed on this policy, including the locked field itself. Default: False

backupDeleteLockDays Integer

Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup's (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value. Default: 0 (no delete blocking)

backupRetainDays Integer

The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Updating this field does NOT affect existing Backups under it. Backups created AFTER a successful update will automatically pick up the new value. NOTE: backup_retain_days must be >= backup_delete_lock_days. If cron_schedule is defined, then this must be <= 360 * the creation interval. Default: 0 (no automatic deletion)

locked Boolean

This flag denotes whether the retention policy of this BackupPlan is locked. If set to True, no further update is allowed on this policy, including the locked field itself. Default: False

backupDeleteLockDays number

Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup's (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value. Default: 0 (no delete blocking)

backupRetainDays number

The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Updating this field does NOT affect existing Backups under it. Backups created AFTER a successful update will automatically pick up the new value. NOTE: backup_retain_days must be >= backup_delete_lock_days. If cron_schedule is defined, then this must be <= 360 * the creation interval. Default: 0 (no automatic deletion)

locked boolean

This flag denotes whether the retention policy of this BackupPlan is locked. If set to True, no further update is allowed on this policy, including the locked field itself. Default: False

backup_delete_lock_days int

Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup's (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value. Default: 0 (no delete blocking)

backup_retain_days int

The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Updating this field does NOT affect existing Backups under it. Backups created AFTER a successful update will automatically pick up the new value. NOTE: backup_retain_days must be >= backup_delete_lock_days. If cron_schedule is defined, then this must be <= 360 * the creation interval. Default: 0 (no automatic deletion)

locked bool

This flag denotes whether the retention policy of this BackupPlan is locked. If set to True, no further update is allowed on this policy, including the locked field itself. Default: False

backupDeleteLockDays Number

Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup's (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value. Default: 0 (no delete blocking)

backupRetainDays Number

The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Updating this field does NOT affect existing Backups under it. Backups created AFTER a successful update will automatically pick up the new value. NOTE: backup_retain_days must be >= backup_delete_lock_days. If cron_schedule is defined, then this must be <= 360 * the creation interval. Default: 0 (no automatic deletion)

locked Boolean

This flag denotes whether the retention policy of this BackupPlan is locked. If set to True, no further update is allowed on this policy, including the locked field itself. Default: False

Schedule

CronSchedule string

A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur.

Paused bool

This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False

CronSchedule string

A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur.

Paused bool

This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False

cronSchedule String

A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur.

paused Boolean

This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False

cronSchedule string

A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur.

paused boolean

This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False

cron_schedule str

A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur.

paused bool

This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False

cronSchedule String

A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur.

paused Boolean

This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False

ScheduleResponse

CronSchedule string

A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur.

Paused bool

This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False

CronSchedule string

A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur.

Paused bool

This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False

cronSchedule String

A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur.

paused Boolean

This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False

cronSchedule string

A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur.

paused boolean

This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False

cron_schedule str

A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur.

paused bool

This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False

cronSchedule String

A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur.

paused Boolean

This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0