1. Packages
  2. Google Cloud Native
  3. API Docs
  4. alloydb
  5. alloydb/v1alpha
  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

google-native.alloydb/v1alpha.Backup

Explore with Pulumi AI

google-native logo

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

    Creates a new Backup in a given project and location. 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_id: Optional[str] = None,
               cluster_name: Optional[str] = None,
               annotations: Optional[Mapping[str, str]] = None,
               description: Optional[str] = None,
               display_name: Optional[str] = None,
               encryption_config: Optional[EncryptionConfigArgs] = None,
               etag: Optional[str] = None,
               labels: Optional[Mapping[str, str]] = None,
               location: Optional[str] = None,
               project: Optional[str] = None,
               request_id: Optional[str] = None,
               type: Optional[BackupType] = 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:alloydb/v1alpha:Backup
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args BackupArgs
    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 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 string
    The unique name of the resource.
    args BackupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var google_nativeBackupResource = new GoogleNative.AlloyDB.V1Alpha.Backup("google-nativeBackupResource", new()
    {
        BackupId = "string",
        ClusterName = "string",
        Annotations = 
        {
            { "string", "string" },
        },
        Description = "string",
        DisplayName = "string",
        EncryptionConfig = new GoogleNative.AlloyDB.V1Alpha.Inputs.EncryptionConfigArgs
        {
            KmsKeyName = "string",
        },
        Etag = "string",
        Labels = 
        {
            { "string", "string" },
        },
        Location = "string",
        Project = "string",
        RequestId = "string",
        Type = GoogleNative.AlloyDB.V1Alpha.BackupType.TypeUnspecified,
    });
    
    example, err := alloydbv1alpha.NewBackup(ctx, "google-nativeBackupResource", &alloydbv1alpha.BackupArgs{
    BackupId: pulumi.String("string"),
    ClusterName: pulumi.String("string"),
    Annotations: pulumi.StringMap{
    "string": pulumi.String("string"),
    },
    Description: pulumi.String("string"),
    DisplayName: pulumi.String("string"),
    EncryptionConfig: &alloydb.EncryptionConfigArgs{
    KmsKeyName: pulumi.String("string"),
    },
    Etag: pulumi.String("string"),
    Labels: pulumi.StringMap{
    "string": pulumi.String("string"),
    },
    Location: pulumi.String("string"),
    Project: pulumi.String("string"),
    RequestId: pulumi.String("string"),
    Type: alloydbv1alpha.BackupTypeTypeUnspecified,
    })
    
    var google_nativeBackupResource = new Backup("google-nativeBackupResource", BackupArgs.builder()        
        .backupId("string")
        .clusterName("string")
        .annotations(Map.of("string", "string"))
        .description("string")
        .displayName("string")
        .encryptionConfig(EncryptionConfigArgs.builder()
            .kmsKeyName("string")
            .build())
        .etag("string")
        .labels(Map.of("string", "string"))
        .location("string")
        .project("string")
        .requestId("string")
        .type("TYPE_UNSPECIFIED")
        .build());
    
    google_native_backup_resource = google_native.alloydb.v1alpha.Backup("google-nativeBackupResource",
        backup_id="string",
        cluster_name="string",
        annotations={
            "string": "string",
        },
        description="string",
        display_name="string",
        encryption_config=google_native.alloydb.v1alpha.EncryptionConfigArgs(
            kms_key_name="string",
        ),
        etag="string",
        labels={
            "string": "string",
        },
        location="string",
        project="string",
        request_id="string",
        type=google_native.alloydb.v1alpha.BackupType.TYPE_UNSPECIFIED)
    
    const google_nativeBackupResource = new google_native.alloydb.v1alpha.Backup("google-nativeBackupResource", {
        backupId: "string",
        clusterName: "string",
        annotations: {
            string: "string",
        },
        description: "string",
        displayName: "string",
        encryptionConfig: {
            kmsKeyName: "string",
        },
        etag: "string",
        labels: {
            string: "string",
        },
        location: "string",
        project: "string",
        requestId: "string",
        type: google_native.alloydb.v1alpha.BackupType.TypeUnspecified,
    });
    
    type: google-native:alloydb/v1alpha:Backup
    properties:
        annotations:
            string: string
        backupId: string
        clusterName: string
        description: string
        displayName: string
        encryptionConfig:
            kmsKeyName: string
        etag: string
        labels:
            string: string
        location: string
        project: string
        requestId: string
        type: TYPE_UNSPECIFIED
    

    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

    The Backup resource accepts the following input properties:

    BackupId string
    Required. ID of the requesting object.
    ClusterName string
    The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
    Annotations Dictionary<string, string>
    Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
    Description string
    User-provided description of the backup.
    DisplayName string
    User-settable and human-readable display name for the Backup.
    EncryptionConfig Pulumi.GoogleNative.AlloyDB.V1Alpha.Inputs.EncryptionConfig
    Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
    Etag string
    For Resource freshness validation (https://google.aip.dev/154)
    Labels Dictionary<string, string>
    Labels as key value pairs
    Location string
    Project string
    RequestId string
    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    Type Pulumi.GoogleNative.AlloyDB.V1Alpha.BackupType
    The backup type, which suggests the trigger for the backup.
    BackupId string
    Required. ID of the requesting object.
    ClusterName string
    The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
    Annotations map[string]string
    Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
    Description string
    User-provided description of the backup.
    DisplayName string
    User-settable and human-readable display name for the Backup.
    EncryptionConfig EncryptionConfigArgs
    Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
    Etag string
    For Resource freshness validation (https://google.aip.dev/154)
    Labels map[string]string
    Labels as key value pairs
    Location string
    Project string
    RequestId string
    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    Type BackupType
    The backup type, which suggests the trigger for the backup.
    backupId String
    Required. ID of the requesting object.
    clusterName String
    The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
    annotations Map<String,String>
    Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
    description String
    User-provided description of the backup.
    displayName String
    User-settable and human-readable display name for the Backup.
    encryptionConfig EncryptionConfig
    Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
    etag String
    For Resource freshness validation (https://google.aip.dev/154)
    labels Map<String,String>
    Labels as key value pairs
    location String
    project String
    requestId String
    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    type BackupType
    The backup type, which suggests the trigger for the backup.
    backupId string
    Required. ID of the requesting object.
    clusterName string
    The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
    annotations {[key: string]: string}
    Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
    description string
    User-provided description of the backup.
    displayName string
    User-settable and human-readable display name for the Backup.
    encryptionConfig EncryptionConfig
    Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
    etag string
    For Resource freshness validation (https://google.aip.dev/154)
    labels {[key: string]: string}
    Labels as key value pairs
    location string
    project string
    requestId string
    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    type BackupType
    The backup type, which suggests the trigger for the backup.
    backup_id str
    Required. ID of the requesting object.
    cluster_name str
    The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
    annotations Mapping[str, str]
    Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
    description str
    User-provided description of the backup.
    display_name str
    User-settable and human-readable display name for the Backup.
    encryption_config EncryptionConfigArgs
    Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
    etag str
    For Resource freshness validation (https://google.aip.dev/154)
    labels Mapping[str, str]
    Labels as key value pairs
    location str
    project str
    request_id str
    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    type BackupType
    The backup type, which suggests the trigger for the backup.
    backupId String
    Required. ID of the requesting object.
    clusterName String
    The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
    annotations Map<String>
    Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
    description String
    User-provided description of the backup.
    displayName String
    User-settable and human-readable display name for the Backup.
    encryptionConfig Property Map
    Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
    etag String
    For Resource freshness validation (https://google.aip.dev/154)
    labels Map<String>
    Labels as key value pairs
    location String
    project String
    requestId String
    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    type "TYPE_UNSPECIFIED" | "ON_DEMAND" | "AUTOMATED" | "CONTINUOUS"
    The backup type, which suggests the trigger for the backup.

    Outputs

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

    ClusterUid string
    The system-generated UID of the cluster which was used to create this resource.
    CreateTime string
    Create time stamp
    DatabaseVersion string
    The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.
    DeleteTime string
    Delete time stamp
    EncryptionInfo Pulumi.GoogleNative.AlloyDB.V1Alpha.Outputs.EncryptionInfoResponse
    The encryption information for the backup.
    ExpiryQuantity Pulumi.GoogleNative.AlloyDB.V1Alpha.Outputs.QuantityBasedExpiryResponse
    The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.
    ExpiryTime string
    The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression [a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource: * projects/{project}/locations/{region}
    Reconciling bool
    Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.
    SatisfiesPzs bool
    Reserved for future use.
    SizeBytes string
    The size of the backup in bytes.
    State string
    The current state of the backup.
    Uid string
    The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
    UpdateTime string
    Update time stamp
    ClusterUid string
    The system-generated UID of the cluster which was used to create this resource.
    CreateTime string
    Create time stamp
    DatabaseVersion string
    The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.
    DeleteTime string
    Delete time stamp
    EncryptionInfo EncryptionInfoResponse
    The encryption information for the backup.
    ExpiryQuantity QuantityBasedExpiryResponse
    The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.
    ExpiryTime string
    The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression [a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource: * projects/{project}/locations/{region}
    Reconciling bool
    Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.
    SatisfiesPzs bool
    Reserved for future use.
    SizeBytes string
    The size of the backup in bytes.
    State string
    The current state of the backup.
    Uid string
    The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
    UpdateTime string
    Update time stamp
    clusterUid String
    The system-generated UID of the cluster which was used to create this resource.
    createTime String
    Create time stamp
    databaseVersion String
    The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.
    deleteTime String
    Delete time stamp
    encryptionInfo EncryptionInfoResponse
    The encryption information for the backup.
    expiryQuantity QuantityBasedExpiryResponse
    The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.
    expiryTime String
    The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression [a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource: * projects/{project}/locations/{region}
    reconciling Boolean
    Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.
    satisfiesPzs Boolean
    Reserved for future use.
    sizeBytes String
    The size of the backup in bytes.
    state String
    The current state of the backup.
    uid String
    The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
    updateTime String
    Update time stamp
    clusterUid string
    The system-generated UID of the cluster which was used to create this resource.
    createTime string
    Create time stamp
    databaseVersion string
    The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.
    deleteTime string
    Delete time stamp
    encryptionInfo EncryptionInfoResponse
    The encryption information for the backup.
    expiryQuantity QuantityBasedExpiryResponse
    The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.
    expiryTime string
    The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression [a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource: * projects/{project}/locations/{region}
    reconciling boolean
    Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.
    satisfiesPzs boolean
    Reserved for future use.
    sizeBytes string
    The size of the backup in bytes.
    state string
    The current state of the backup.
    uid string
    The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
    updateTime string
    Update time stamp
    cluster_uid str
    The system-generated UID of the cluster which was used to create this resource.
    create_time str
    Create time stamp
    database_version str
    The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.
    delete_time str
    Delete time stamp
    encryption_info EncryptionInfoResponse
    The encryption information for the backup.
    expiry_quantity QuantityBasedExpiryResponse
    The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.
    expiry_time str
    The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression [a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource: * projects/{project}/locations/{region}
    reconciling bool
    Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.
    satisfies_pzs bool
    Reserved for future use.
    size_bytes str
    The size of the backup in bytes.
    state str
    The current state of the backup.
    uid str
    The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
    update_time str
    Update time stamp
    clusterUid String
    The system-generated UID of the cluster which was used to create this resource.
    createTime String
    Create time stamp
    databaseVersion String
    The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.
    deleteTime String
    Delete time stamp
    encryptionInfo Property Map
    The encryption information for the backup.
    expiryQuantity Property Map
    The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.
    expiryTime String
    The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression [a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource: * projects/{project}/locations/{region}
    reconciling Boolean
    Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.
    satisfiesPzs Boolean
    Reserved for future use.
    sizeBytes String
    The size of the backup in bytes.
    state String
    The current state of the backup.
    uid String
    The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
    updateTime String
    Update time stamp

    Supporting Types

    BackupType, BackupTypeArgs

    TypeUnspecified
    TYPE_UNSPECIFIEDBackup Type is unknown.
    OnDemand
    ON_DEMANDON_DEMAND backups that were triggered by the customer (e.g., not AUTOMATED).
    Automated
    AUTOMATEDAUTOMATED backups triggered by the automated backups scheduler pursuant to an automated backup policy.
    Continuous
    CONTINUOUSCONTINUOUS backups triggered by the automated backups scheduler due to a continuous backup policy.
    BackupTypeTypeUnspecified
    TYPE_UNSPECIFIEDBackup Type is unknown.
    BackupTypeOnDemand
    ON_DEMANDON_DEMAND backups that were triggered by the customer (e.g., not AUTOMATED).
    BackupTypeAutomated
    AUTOMATEDAUTOMATED backups triggered by the automated backups scheduler pursuant to an automated backup policy.
    BackupTypeContinuous
    CONTINUOUSCONTINUOUS backups triggered by the automated backups scheduler due to a continuous backup policy.
    TypeUnspecified
    TYPE_UNSPECIFIEDBackup Type is unknown.
    OnDemand
    ON_DEMANDON_DEMAND backups that were triggered by the customer (e.g., not AUTOMATED).
    Automated
    AUTOMATEDAUTOMATED backups triggered by the automated backups scheduler pursuant to an automated backup policy.
    Continuous
    CONTINUOUSCONTINUOUS backups triggered by the automated backups scheduler due to a continuous backup policy.
    TypeUnspecified
    TYPE_UNSPECIFIEDBackup Type is unknown.
    OnDemand
    ON_DEMANDON_DEMAND backups that were triggered by the customer (e.g., not AUTOMATED).
    Automated
    AUTOMATEDAUTOMATED backups triggered by the automated backups scheduler pursuant to an automated backup policy.
    Continuous
    CONTINUOUSCONTINUOUS backups triggered by the automated backups scheduler due to a continuous backup policy.
    TYPE_UNSPECIFIED
    TYPE_UNSPECIFIEDBackup Type is unknown.
    ON_DEMAND
    ON_DEMANDON_DEMAND backups that were triggered by the customer (e.g., not AUTOMATED).
    AUTOMATED
    AUTOMATEDAUTOMATED backups triggered by the automated backups scheduler pursuant to an automated backup policy.
    CONTINUOUS
    CONTINUOUSCONTINUOUS backups triggered by the automated backups scheduler due to a continuous backup policy.
    "TYPE_UNSPECIFIED"
    TYPE_UNSPECIFIEDBackup Type is unknown.
    "ON_DEMAND"
    ON_DEMANDON_DEMAND backups that were triggered by the customer (e.g., not AUTOMATED).
    "AUTOMATED"
    AUTOMATEDAUTOMATED backups triggered by the automated backups scheduler pursuant to an automated backup policy.
    "CONTINUOUS"
    CONTINUOUSCONTINUOUS backups triggered by the automated backups scheduler due to a continuous backup policy.

    EncryptionConfig, EncryptionConfigArgs

    KmsKeyName string
    The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
    KmsKeyName string
    The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
    kmsKeyName String
    The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
    kmsKeyName string
    The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
    kms_key_name str
    The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
    kmsKeyName String
    The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]

    EncryptionConfigResponse, EncryptionConfigResponseArgs

    KmsKeyName string
    The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
    KmsKeyName string
    The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
    kmsKeyName String
    The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
    kmsKeyName string
    The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
    kms_key_name str
    The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
    kmsKeyName String
    The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]

    EncryptionInfoResponse, EncryptionInfoResponseArgs

    EncryptionType string
    Type of encryption.
    KmsKeyVersions List<string>
    Cloud KMS key versions that are being used to protect the database or the backup.
    EncryptionType string
    Type of encryption.
    KmsKeyVersions []string
    Cloud KMS key versions that are being used to protect the database or the backup.
    encryptionType String
    Type of encryption.
    kmsKeyVersions List<String>
    Cloud KMS key versions that are being used to protect the database or the backup.
    encryptionType string
    Type of encryption.
    kmsKeyVersions string[]
    Cloud KMS key versions that are being used to protect the database or the backup.
    encryption_type str
    Type of encryption.
    kms_key_versions Sequence[str]
    Cloud KMS key versions that are being used to protect the database or the backup.
    encryptionType String
    Type of encryption.
    kmsKeyVersions List<String>
    Cloud KMS key versions that are being used to protect the database or the backup.

    QuantityBasedExpiryResponse, QuantityBasedExpiryResponseArgs

    RetentionCount int
    The backup's position among its backups with the same source cluster and type, by descending chronological order create time(i.e. newest first).
    TotalRetentionCount int
    The length of the quantity-based queue, specified by the backup's retention policy.
    RetentionCount int
    The backup's position among its backups with the same source cluster and type, by descending chronological order create time(i.e. newest first).
    TotalRetentionCount int
    The length of the quantity-based queue, specified by the backup's retention policy.
    retentionCount Integer
    The backup's position among its backups with the same source cluster and type, by descending chronological order create time(i.e. newest first).
    totalRetentionCount Integer
    The length of the quantity-based queue, specified by the backup's retention policy.
    retentionCount number
    The backup's position among its backups with the same source cluster and type, by descending chronological order create time(i.e. newest first).
    totalRetentionCount number
    The length of the quantity-based queue, specified by the backup's retention policy.
    retention_count int
    The backup's position among its backups with the same source cluster and type, by descending chronological order create time(i.e. newest first).
    total_retention_count int
    The length of the quantity-based queue, specified by the backup's retention policy.
    retentionCount Number
    The backup's position among its backups with the same source cluster and type, by descending chronological order create time(i.e. newest first).
    totalRetentionCount Number
    The length of the quantity-based queue, specified by the backup's retention policy.

    Package Details

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

    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