Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Netapp-Cloudmanager Provider
  3. API Docs
  4. Cbs
netapp-cloudmanager 25.3.0 published on Monday, Apr 14, 2025 by netapp
netapp/terraform-provider-netapp-cloudmanager

netapp-cloudmanager.Cbs

Explore with Pulumi AI

netapp-cloudmanager logo
netapp-cloudmanager 25.3.0 published on Monday, Apr 14, 2025 by netapp
netapp/terraform-provider-netapp-cloudmanager

    Provides a netapp-cloudmanager_cbs resource. This can be used to enable cloud backup on a specific working environment Cloud Volumes ONTAP on AWS and Azure. Requires existence of a Cloud Manager Connector and a Cloud Volumes ONTAP system.

    Example Usage

    Create Cbs Resource

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

    Constructor syntax

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

@overload
def Cbs(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        client_id: Optional[str] = None,
        account_id: Optional[str] = None,
        cloud_provider: Optional[str] = None,
        export_existing_snapshots: Optional[bool] = None,
        backup_policy: Optional[CbsBackupPolicyArgs] = None,
        bucket: Optional[str] = None,
        cbs_id: Optional[str] = None,
        aws_cbs_parameters: Optional[CbsAwsCbsParametersArgs] = None,
        auto_backup_enabled: Optional[bool] = None,
        azure_cbs_parameters: Optional[CbsAzureCbsParametersArgs] = None,
        ip_space: Optional[str] = None,
        max_transfer_rate: Optional[float] = None,
        region: Optional[str] = None,
        volumes: Optional[Sequence[CbsVolumeArgs]] = None,
        working_environment_id: Optional[str] = None,
        working_environment_name: Optional[str] = None)
    func NewCbs(ctx *Context, name string, args CbsArgs, opts ...ResourceOption) (*Cbs, error)
    public Cbs(string name, CbsArgs args, CustomResourceOptions? opts = null)
    public Cbs(String name, CbsArgs args)
public Cbs(String name, CbsArgs args, CustomResourceOptions options)

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

    Constructor example

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

    var cbsResource = new NetappCloudmanager.Cbs("cbsResource", new()
{
    ClientId = "string",
    AccountId = "string",
    CloudProvider = "string",
    ExportExistingSnapshots = false,
    BackupPolicy = new NetappCloudmanager.Inputs.CbsBackupPolicyArgs
    {
        Name = "string",
        ArchiveAfterDays = "string",
        ObjectLock = "string",
        PolicyRules = new[]
        {
            new NetappCloudmanager.Inputs.CbsBackupPolicyPolicyRuleArgs
            {
                Rules = new[]
                {
                    new NetappCloudmanager.Inputs.CbsBackupPolicyPolicyRuleRuleArgs
                    {
                        Label = "string",
                        Retention = "string",
                    },
                },
            },
        },
    },
    Bucket = "string",
    CbsId = "string",
    AwsCbsParameters = new NetappCloudmanager.Inputs.CbsAwsCbsParametersArgs
    {
        AccessKey = "string",
        ArchiveStorageClass = "string",
        AwsAccountId = "string",
        KmsKeyId = "string",
        PrivateEndpointId = "string",
        SecretPassword = "string",
    },
    AutoBackupEnabled = false,
    AzureCbsParameters = new NetappCloudmanager.Inputs.CbsAzureCbsParametersArgs
    {
        KeyName = "string",
        KeyVaultId = "string",
        PrivateEndpointId = "string",
        ResourceGroup = "string",
        StorageAccount = "string",
        Subscription = "string",
    },
    IpSpace = "string",
    MaxTransferRate = 0,
    Region = "string",
    Volumes = new[]
    {
        new NetappCloudmanager.Inputs.CbsVolumeArgs
        {
            VolumeName = "string",
            BackupPolicy = new NetappCloudmanager.Inputs.CbsVolumeBackupPolicyArgs
            {
                Name = "string",
                ArchiveAfterDays = "string",
                ObjectLock = "string",
                PolicyRules = new[]
                {
                    new NetappCloudmanager.Inputs.CbsVolumeBackupPolicyPolicyRuleArgs
                    {
                        Rules = new[]
                        {
                            new NetappCloudmanager.Inputs.CbsVolumeBackupPolicyPolicyRuleRuleArgs
                            {
                                Label = "string",
                                Retention = "string",
                            },
                        },
                    },
                },
            },
            Mode = "string",
        },
    },
    WorkingEnvironmentId = "string",
    WorkingEnvironmentName = "string",
});

    example, err := netappcloudmanager.NewCbs(ctx, "cbsResource", &netappcloudmanager.CbsArgs{
	ClientId:                pulumi.String("string"),
	AccountId:               pulumi.String("string"),
	CloudProvider:           pulumi.String("string"),
	ExportExistingSnapshots: pulumi.Bool(false),
	BackupPolicy: &netappcloudmanager.CbsBackupPolicyArgs{
		Name:             pulumi.String("string"),
		ArchiveAfterDays: pulumi.String("string"),
		ObjectLock:       pulumi.String("string"),
		PolicyRules: netappcloudmanager.CbsBackupPolicyPolicyRuleArray{
			&netappcloudmanager.CbsBackupPolicyPolicyRuleArgs{
				Rules: netappcloudmanager.CbsBackupPolicyPolicyRuleRuleArray{
					&netappcloudmanager.CbsBackupPolicyPolicyRuleRuleArgs{
						Label:     pulumi.String("string"),
						Retention: pulumi.String("string"),
					},
				},
			},
		},
	},
	Bucket: pulumi.String("string"),
	CbsId:  pulumi.String("string"),
	AwsCbsParameters: &netappcloudmanager.CbsAwsCbsParametersArgs{
		AccessKey:           pulumi.String("string"),
		ArchiveStorageClass: pulumi.String("string"),
		AwsAccountId:        pulumi.String("string"),
		KmsKeyId:            pulumi.String("string"),
		PrivateEndpointId:   pulumi.String("string"),
		SecretPassword:      pulumi.String("string"),
	},
	AutoBackupEnabled: pulumi.Bool(false),
	AzureCbsParameters: &netappcloudmanager.CbsAzureCbsParametersArgs{
		KeyName:           pulumi.String("string"),
		KeyVaultId:        pulumi.String("string"),
		PrivateEndpointId: pulumi.String("string"),
		ResourceGroup:     pulumi.String("string"),
		StorageAccount:    pulumi.String("string"),
		Subscription:      pulumi.String("string"),
	},
	IpSpace:         pulumi.String("string"),
	MaxTransferRate: pulumi.Float64(0),
	Region:          pulumi.String("string"),
	Volumes: netappcloudmanager.CbsVolumeArray{
		&netappcloudmanager.CbsVolumeArgs{
			VolumeName: pulumi.String("string"),
			BackupPolicy: &netappcloudmanager.CbsVolumeBackupPolicyArgs{
				Name:             pulumi.String("string"),
				ArchiveAfterDays: pulumi.String("string"),
				ObjectLock:       pulumi.String("string"),
				PolicyRules: netappcloudmanager.CbsVolumeBackupPolicyPolicyRuleArray{
					&netappcloudmanager.CbsVolumeBackupPolicyPolicyRuleArgs{
						Rules: netappcloudmanager.CbsVolumeBackupPolicyPolicyRuleRuleArray{
							&netappcloudmanager.CbsVolumeBackupPolicyPolicyRuleRuleArgs{
								Label:     pulumi.String("string"),
								Retention: pulumi.String("string"),
							},
						},
					},
				},
			},
			Mode: pulumi.String("string"),
		},
	},
	WorkingEnvironmentId:   pulumi.String("string"),
	WorkingEnvironmentName: pulumi.String("string"),
})

    var cbsResource = new Cbs("cbsResource", CbsArgs.builder()
    .clientId("string")
    .accountId("string")
    .cloudProvider("string")
    .exportExistingSnapshots(false)
    .backupPolicy(CbsBackupPolicyArgs.builder()
        .name("string")
        .archiveAfterDays("string")
        .objectLock("string")
        .policyRules(CbsBackupPolicyPolicyRuleArgs.builder()
            .rules(CbsBackupPolicyPolicyRuleRuleArgs.builder()
                .label("string")
                .retention("string")
                .build())
            .build())
        .build())
    .bucket("string")
    .cbsId("string")
    .awsCbsParameters(CbsAwsCbsParametersArgs.builder()
        .accessKey("string")
        .archiveStorageClass("string")
        .awsAccountId("string")
        .kmsKeyId("string")
        .privateEndpointId("string")
        .secretPassword("string")
        .build())
    .autoBackupEnabled(false)
    .azureCbsParameters(CbsAzureCbsParametersArgs.builder()
        .keyName("string")
        .keyVaultId("string")
        .privateEndpointId("string")
        .resourceGroup("string")
        .storageAccount("string")
        .subscription("string")
        .build())
    .ipSpace("string")
    .maxTransferRate(0)
    .region("string")
    .volumes(CbsVolumeArgs.builder()
        .volumeName("string")
        .backupPolicy(CbsVolumeBackupPolicyArgs.builder()
            .name("string")
            .archiveAfterDays("string")
            .objectLock("string")
            .policyRules(CbsVolumeBackupPolicyPolicyRuleArgs.builder()
                .rules(CbsVolumeBackupPolicyPolicyRuleRuleArgs.builder()
                    .label("string")
                    .retention("string")
                    .build())
                .build())
            .build())
        .mode("string")
        .build())
    .workingEnvironmentId("string")
    .workingEnvironmentName("string")
    .build());

    cbs_resource = netapp_cloudmanager.Cbs("cbsResource",
    client_id="string",
    account_id="string",
    cloud_provider="string",
    export_existing_snapshots=False,
    backup_policy={
        "name": "string",
        "archive_after_days": "string",
        "object_lock": "string",
        "policy_rules": [{
            "rules": [{
                "label": "string",
                "retention": "string",
            }],
        }],
    },
    bucket="string",
    cbs_id="string",
    aws_cbs_parameters={
        "access_key": "string",
        "archive_storage_class": "string",
        "aws_account_id": "string",
        "kms_key_id": "string",
        "private_endpoint_id": "string",
        "secret_password": "string",
    },
    auto_backup_enabled=False,
    azure_cbs_parameters={
        "key_name": "string",
        "key_vault_id": "string",
        "private_endpoint_id": "string",
        "resource_group": "string",
        "storage_account": "string",
        "subscription": "string",
    },
    ip_space="string",
    max_transfer_rate=0,
    region="string",
    volumes=[{
        "volume_name": "string",
        "backup_policy": {
            "name": "string",
            "archive_after_days": "string",
            "object_lock": "string",
            "policy_rules": [{
                "rules": [{
                    "label": "string",
                    "retention": "string",
                }],
            }],
        },
        "mode": "string",
    }],
    working_environment_id="string",
    working_environment_name="string")

    const cbsResource = new netapp_cloudmanager.Cbs("cbsResource", {
    clientId: "string",
    accountId: "string",
    cloudProvider: "string",
    exportExistingSnapshots: false,
    backupPolicy: {
        name: "string",
        archiveAfterDays: "string",
        objectLock: "string",
        policyRules: [{
            rules: [{
                label: "string",
                retention: "string",
            }],
        }],
    },
    bucket: "string",
    cbsId: "string",
    awsCbsParameters: {
        accessKey: "string",
        archiveStorageClass: "string",
        awsAccountId: "string",
        kmsKeyId: "string",
        privateEndpointId: "string",
        secretPassword: "string",
    },
    autoBackupEnabled: false,
    azureCbsParameters: {
        keyName: "string",
        keyVaultId: "string",
        privateEndpointId: "string",
        resourceGroup: "string",
        storageAccount: "string",
        subscription: "string",
    },
    ipSpace: "string",
    maxTransferRate: 0,
    region: "string",
    volumes: [{
        volumeName: "string",
        backupPolicy: {
            name: "string",
            archiveAfterDays: "string",
            objectLock: "string",
            policyRules: [{
                rules: [{
                    label: "string",
                    retention: "string",
                }],
            }],
        },
        mode: "string",
    }],
    workingEnvironmentId: "string",
    workingEnvironmentName: "string",
});

    type: netapp-cloudmanager:Cbs
properties:
    accountId: string
    autoBackupEnabled: false
    awsCbsParameters:
        accessKey: string
        archiveStorageClass: string
        awsAccountId: string
        kmsKeyId: string
        privateEndpointId: string
        secretPassword: string
    azureCbsParameters:
        keyName: string
        keyVaultId: string
        privateEndpointId: string
        resourceGroup: string
        storageAccount: string
        subscription: string
    backupPolicy:
        archiveAfterDays: string
        name: string
        objectLock: string
        policyRules:
            - rules:
                - label: string
                  retention: string
    bucket: string
    cbsId: string
    clientId: string
    cloudProvider: string
    exportExistingSnapshots: false
    ipSpace: string
    maxTransferRate: 0
    region: string
    volumes:
        - backupPolicy:
            archiveAfterDays: string
            name: string
            objectLock: string
            policyRules:
                - rules:
                    - label: string
                      retention: string
          mode: string
          volumeName: string
    workingEnvironmentId: string
    workingEnvironmentName: string

    Cbs Resource Properties

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

    Inputs

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

    The Cbs resource accepts the following input properties:

    AccountId string
    The NetApp account ID that the backup cloud will be associated with. You can find the account ID in the account tab of Cloud Manager at https://console.bluexp.netapp.com/.
    ClientId string
    The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
    AutoBackupEnabled bool
    Auto backup all volumes in working environments.
    AwsCbsParameters Pulumi.NetappCloudmanager.Inputs.CbsAwsCbsParameters
    AzureCbsParameters Pulumi.NetappCloudmanager.Inputs.CbsAzureCbsParameters
    BackupPolicy Pulumi.NetappCloudmanager.Inputs.CbsBackupPolicy
    Bucket string
    CbsId string
    The unique identifier for the cloud backup service.
    CloudProvider string
    Need to be one of ['AWS', 'AZURE', 'GCP']
    ExportExistingSnapshots bool
    Export pre-existing Snapshot copies to object storage
    IpSpace string
    MaxTransferRate double
    Modifies node level throttling of an ONTAP cluster. Value to be specified in kilo bytes per second(kbps). A value of 0 implies Unlimited throttling.
    Region string
    The region where the working environment created.
    Volumes List<Pulumi.NetappCloudmanager.Inputs.CbsVolume>
    WorkingEnvironmentId string
    The public ID of the working environment where the aggregate will be created. This argument is optional if working_environment_name is provided. You can find the ID from a previous create Cloud Volumes ONTAP action as shown in the example, or from the information page of the Cloud Volumes ONTAP working environment on https://console.bluexp.netapp.com/.
    WorkingEnvironmentName string
    The working environment name where the aggregate will be created. This argument will be ignored if working_environment_id is provided.
    AccountId string
    The NetApp account ID that the backup cloud will be associated with. You can find the account ID in the account tab of Cloud Manager at https://console.bluexp.netapp.com/.
    ClientId string
    The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
    AutoBackupEnabled bool
    Auto backup all volumes in working environments.
    AwsCbsParameters CbsAwsCbsParametersArgs
    AzureCbsParameters CbsAzureCbsParametersArgs
    BackupPolicy CbsBackupPolicyArgs
    Bucket string
    CbsId string
    The unique identifier for the cloud backup service.
    CloudProvider string
    Need to be one of ['AWS', 'AZURE', 'GCP']
    ExportExistingSnapshots bool
    Export pre-existing Snapshot copies to object storage
    IpSpace string
    MaxTransferRate float64
    Modifies node level throttling of an ONTAP cluster. Value to be specified in kilo bytes per second(kbps). A value of 0 implies Unlimited throttling.
    Region string
    The region where the working environment created.
    Volumes []CbsVolumeArgs
    WorkingEnvironmentId string
    The public ID of the working environment where the aggregate will be created. This argument is optional if working_environment_name is provided. You can find the ID from a previous create Cloud Volumes ONTAP action as shown in the example, or from the information page of the Cloud Volumes ONTAP working environment on https://console.bluexp.netapp.com/.
    WorkingEnvironmentName string
    The working environment name where the aggregate will be created. This argument will be ignored if working_environment_id is provided.
    accountId String
    The NetApp account ID that the backup cloud will be associated with. You can find the account ID in the account tab of Cloud Manager at https://console.bluexp.netapp.com/.
    clientId String
    The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
    autoBackupEnabled Boolean
    Auto backup all volumes in working environments.
    awsCbsParameters CbsAwsCbsParameters
    azureCbsParameters CbsAzureCbsParameters
    backupPolicy CbsBackupPolicy
    bucket String
    cbsId String
    The unique identifier for the cloud backup service.
    cloudProvider String
    Need to be one of ['AWS', 'AZURE', 'GCP']
    exportExistingSnapshots Boolean
    Export pre-existing Snapshot copies to object storage
    ipSpace String
    maxTransferRate Double
    Modifies node level throttling of an ONTAP cluster. Value to be specified in kilo bytes per second(kbps). A value of 0 implies Unlimited throttling.
    region String
    The region where the working environment created.
    volumes List<CbsVolume>
    workingEnvironmentId String
    The public ID of the working environment where the aggregate will be created. This argument is optional if working_environment_name is provided. You can find the ID from a previous create Cloud Volumes ONTAP action as shown in the example, or from the information page of the Cloud Volumes ONTAP working environment on https://console.bluexp.netapp.com/.
    workingEnvironmentName String
    The working environment name where the aggregate will be created. This argument will be ignored if working_environment_id is provided.
    accountId string
    The NetApp account ID that the backup cloud will be associated with. You can find the account ID in the account tab of Cloud Manager at https://console.bluexp.netapp.com/.
    clientId string
    The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
    autoBackupEnabled boolean
    Auto backup all volumes in working environments.
    awsCbsParameters CbsAwsCbsParameters
    azureCbsParameters CbsAzureCbsParameters
    backupPolicy CbsBackupPolicy
    bucket string
    cbsId string
    The unique identifier for the cloud backup service.
    cloudProvider string
    Need to be one of ['AWS', 'AZURE', 'GCP']
    exportExistingSnapshots boolean
    Export pre-existing Snapshot copies to object storage
    ipSpace string
    maxTransferRate number
    Modifies node level throttling of an ONTAP cluster. Value to be specified in kilo bytes per second(kbps). A value of 0 implies Unlimited throttling.
    region string
    The region where the working environment created.
    volumes CbsVolume[]
    workingEnvironmentId string
    The public ID of the working environment where the aggregate will be created. This argument is optional if working_environment_name is provided. You can find the ID from a previous create Cloud Volumes ONTAP action as shown in the example, or from the information page of the Cloud Volumes ONTAP working environment on https://console.bluexp.netapp.com/.
    workingEnvironmentName string
    The working environment name where the aggregate will be created. This argument will be ignored if working_environment_id is provided.
    account_id str
    The NetApp account ID that the backup cloud will be associated with. You can find the account ID in the account tab of Cloud Manager at https://console.bluexp.netapp.com/.
    client_id str
    The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
    auto_backup_enabled bool
    Auto backup all volumes in working environments.
    aws_cbs_parameters CbsAwsCbsParametersArgs
    azure_cbs_parameters CbsAzureCbsParametersArgs
    backup_policy CbsBackupPolicyArgs
    bucket str
    cbs_id str
    The unique identifier for the cloud backup service.
    cloud_provider str
    Need to be one of ['AWS', 'AZURE', 'GCP']
    export_existing_snapshots bool
    Export pre-existing Snapshot copies to object storage
    ip_space str
    max_transfer_rate float
    Modifies node level throttling of an ONTAP cluster. Value to be specified in kilo bytes per second(kbps). A value of 0 implies Unlimited throttling.
    region str
    The region where the working environment created.
    volumes Sequence[CbsVolumeArgs]
    working_environment_id str
    The public ID of the working environment where the aggregate will be created. This argument is optional if working_environment_name is provided. You can find the ID from a previous create Cloud Volumes ONTAP action as shown in the example, or from the information page of the Cloud Volumes ONTAP working environment on https://console.bluexp.netapp.com/.
    working_environment_name str
    The working environment name where the aggregate will be created. This argument will be ignored if working_environment_id is provided.
    accountId String
    The NetApp account ID that the backup cloud will be associated with. You can find the account ID in the account tab of Cloud Manager at https://console.bluexp.netapp.com/.
    clientId String
    The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
    autoBackupEnabled Boolean
    Auto backup all volumes in working environments.
    awsCbsParameters Property Map
    azureCbsParameters Property Map
    backupPolicy Property Map
    bucket String
    cbsId String
    The unique identifier for the cloud backup service.
    cloudProvider String
    Need to be one of ['AWS', 'AZURE', 'GCP']
    exportExistingSnapshots Boolean
    Export pre-existing Snapshot copies to object storage
    ipSpace String
    maxTransferRate Number
    Modifies node level throttling of an ONTAP cluster. Value to be specified in kilo bytes per second(kbps). A value of 0 implies Unlimited throttling.
    region String
    The region where the working environment created.
    volumes List<Property Map>
    workingEnvironmentId String
    The public ID of the working environment where the aggregate will be created. This argument is optional if working_environment_name is provided. You can find the ID from a previous create Cloud Volumes ONTAP action as shown in the example, or from the information page of the Cloud Volumes ONTAP working environment on https://console.bluexp.netapp.com/.
    workingEnvironmentName String
    The working environment name where the aggregate will be created. This argument will be ignored if working_environment_id is provided.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Cbs Resource

    Get an existing Cbs resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CbsState, opts?: CustomResourceOptions): Cbs
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        auto_backup_enabled: Optional[bool] = None,
        aws_cbs_parameters: Optional[CbsAwsCbsParametersArgs] = None,
        azure_cbs_parameters: Optional[CbsAzureCbsParametersArgs] = None,
        backup_policy: Optional[CbsBackupPolicyArgs] = None,
        bucket: Optional[str] = None,
        cbs_id: Optional[str] = None,
        client_id: Optional[str] = None,
        cloud_provider: Optional[str] = None,
        export_existing_snapshots: Optional[bool] = None,
        ip_space: Optional[str] = None,
        max_transfer_rate: Optional[float] = None,
        region: Optional[str] = None,
        volumes: Optional[Sequence[CbsVolumeArgs]] = None,
        working_environment_id: Optional[str] = None,
        working_environment_name: Optional[str] = None) -> Cbs
    func GetCbs(ctx *Context, name string, id IDInput, state *CbsState, opts ...ResourceOption) (*Cbs, error)
    public static Cbs Get(string name, Input<string> id, CbsState? state, CustomResourceOptions? opts = null)
    public static Cbs get(String name, Output<String> id, CbsState state, CustomResourceOptions options)
    resources:  _:    type: netapp-cloudmanager:Cbs    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountId string
    The NetApp account ID that the backup cloud will be associated with. You can find the account ID in the account tab of Cloud Manager at https://console.bluexp.netapp.com/.
    AutoBackupEnabled bool
    Auto backup all volumes in working environments.
    AwsCbsParameters Pulumi.NetappCloudmanager.Inputs.CbsAwsCbsParameters
    AzureCbsParameters Pulumi.NetappCloudmanager.Inputs.CbsAzureCbsParameters
    BackupPolicy Pulumi.NetappCloudmanager.Inputs.CbsBackupPolicy
    Bucket string
    CbsId string
    The unique identifier for the cloud backup service.
    ClientId string
    The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
    CloudProvider string
    Need to be one of ['AWS', 'AZURE', 'GCP']
    ExportExistingSnapshots bool
    Export pre-existing Snapshot copies to object storage
    IpSpace string
    MaxTransferRate double
    Modifies node level throttling of an ONTAP cluster. Value to be specified in kilo bytes per second(kbps). A value of 0 implies Unlimited throttling.
    Region string
    The region where the working environment created.
    Volumes List<Pulumi.NetappCloudmanager.Inputs.CbsVolume>
    WorkingEnvironmentId string
    The public ID of the working environment where the aggregate will be created. This argument is optional if working_environment_name is provided. You can find the ID from a previous create Cloud Volumes ONTAP action as shown in the example, or from the information page of the Cloud Volumes ONTAP working environment on https://console.bluexp.netapp.com/.
    WorkingEnvironmentName string
    The working environment name where the aggregate will be created. This argument will be ignored if working_environment_id is provided.
    AccountId string
    The NetApp account ID that the backup cloud will be associated with. You can find the account ID in the account tab of Cloud Manager at https://console.bluexp.netapp.com/.
    AutoBackupEnabled bool
    Auto backup all volumes in working environments.
    AwsCbsParameters CbsAwsCbsParametersArgs
    AzureCbsParameters CbsAzureCbsParametersArgs
    BackupPolicy CbsBackupPolicyArgs
    Bucket string
    CbsId string
    The unique identifier for the cloud backup service.
    ClientId string
    The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
    CloudProvider string
    Need to be one of ['AWS', 'AZURE', 'GCP']
    ExportExistingSnapshots bool
    Export pre-existing Snapshot copies to object storage
    IpSpace string
    MaxTransferRate float64
    Modifies node level throttling of an ONTAP cluster. Value to be specified in kilo bytes per second(kbps). A value of 0 implies Unlimited throttling.
    Region string
    The region where the working environment created.
    Volumes []CbsVolumeArgs
    WorkingEnvironmentId string
    The public ID of the working environment where the aggregate will be created. This argument is optional if working_environment_name is provided. You can find the ID from a previous create Cloud Volumes ONTAP action as shown in the example, or from the information page of the Cloud Volumes ONTAP working environment on https://console.bluexp.netapp.com/.
    WorkingEnvironmentName string
    The working environment name where the aggregate will be created. This argument will be ignored if working_environment_id is provided.
    accountId String
    The NetApp account ID that the backup cloud will be associated with. You can find the account ID in the account tab of Cloud Manager at https://console.bluexp.netapp.com/.
    autoBackupEnabled Boolean
    Auto backup all volumes in working environments.
    awsCbsParameters CbsAwsCbsParameters
    azureCbsParameters CbsAzureCbsParameters
    backupPolicy CbsBackupPolicy
    bucket String
    cbsId String
    The unique identifier for the cloud backup service.
    clientId String
    The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
    cloudProvider String
    Need to be one of ['AWS', 'AZURE', 'GCP']
    exportExistingSnapshots Boolean
    Export pre-existing Snapshot copies to object storage
    ipSpace String
    maxTransferRate Double
    Modifies node level throttling of an ONTAP cluster. Value to be specified in kilo bytes per second(kbps). A value of 0 implies Unlimited throttling.
    region String
    The region where the working environment created.
    volumes List<CbsVolume>
    workingEnvironmentId String
    The public ID of the working environment where the aggregate will be created. This argument is optional if working_environment_name is provided. You can find the ID from a previous create Cloud Volumes ONTAP action as shown in the example, or from the information page of the Cloud Volumes ONTAP working environment on https://console.bluexp.netapp.com/.
    workingEnvironmentName String
    The working environment name where the aggregate will be created. This argument will be ignored if working_environment_id is provided.
    accountId string
    The NetApp account ID that the backup cloud will be associated with. You can find the account ID in the account tab of Cloud Manager at https://console.bluexp.netapp.com/.
    autoBackupEnabled boolean
    Auto backup all volumes in working environments.
    awsCbsParameters CbsAwsCbsParameters
    azureCbsParameters CbsAzureCbsParameters
    backupPolicy CbsBackupPolicy
    bucket string
    cbsId string
    The unique identifier for the cloud backup service.
    clientId string
    The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
    cloudProvider string
    Need to be one of ['AWS', 'AZURE', 'GCP']
    exportExistingSnapshots boolean
    Export pre-existing Snapshot copies to object storage
    ipSpace string
    maxTransferRate number
    Modifies node level throttling of an ONTAP cluster. Value to be specified in kilo bytes per second(kbps). A value of 0 implies Unlimited throttling.
    region string
    The region where the working environment created.
    volumes CbsVolume[]
    workingEnvironmentId string
    The public ID of the working environment where the aggregate will be created. This argument is optional if working_environment_name is provided. You can find the ID from a previous create Cloud Volumes ONTAP action as shown in the example, or from the information page of the Cloud Volumes ONTAP working environment on https://console.bluexp.netapp.com/.
    workingEnvironmentName string
    The working environment name where the aggregate will be created. This argument will be ignored if working_environment_id is provided.
    account_id str
    The NetApp account ID that the backup cloud will be associated with. You can find the account ID in the account tab of Cloud Manager at https://console.bluexp.netapp.com/.
    auto_backup_enabled bool
    Auto backup all volumes in working environments.
    aws_cbs_parameters CbsAwsCbsParametersArgs
    azure_cbs_parameters CbsAzureCbsParametersArgs
    backup_policy CbsBackupPolicyArgs
    bucket str
    cbs_id str
    The unique identifier for the cloud backup service.
    client_id str
    The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
    cloud_provider str
    Need to be one of ['AWS', 'AZURE', 'GCP']
    export_existing_snapshots bool
    Export pre-existing Snapshot copies to object storage
    ip_space str
    max_transfer_rate float
    Modifies node level throttling of an ONTAP cluster. Value to be specified in kilo bytes per second(kbps). A value of 0 implies Unlimited throttling.
    region str
    The region where the working environment created.
    volumes Sequence[CbsVolumeArgs]
    working_environment_id str
    The public ID of the working environment where the aggregate will be created. This argument is optional if working_environment_name is provided. You can find the ID from a previous create Cloud Volumes ONTAP action as shown in the example, or from the information page of the Cloud Volumes ONTAP working environment on https://console.bluexp.netapp.com/.
    working_environment_name str
    The working environment name where the aggregate will be created. This argument will be ignored if working_environment_id is provided.
    accountId String
    The NetApp account ID that the backup cloud will be associated with. You can find the account ID in the account tab of Cloud Manager at https://console.bluexp.netapp.com/.
    autoBackupEnabled Boolean
    Auto backup all volumes in working environments.
    awsCbsParameters Property Map
    azureCbsParameters Property Map
    backupPolicy Property Map
    bucket String
    cbsId String
    The unique identifier for the cloud backup service.
    clientId String
    The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
    cloudProvider String
    Need to be one of ['AWS', 'AZURE', 'GCP']
    exportExistingSnapshots Boolean
    Export pre-existing Snapshot copies to object storage
    ipSpace String
    maxTransferRate Number
    Modifies node level throttling of an ONTAP cluster. Value to be specified in kilo bytes per second(kbps). A value of 0 implies Unlimited throttling.
    region String
    The region where the working environment created.
    volumes List<Property Map>
    workingEnvironmentId String
    The public ID of the working environment where the aggregate will be created. This argument is optional if working_environment_name is provided. You can find the ID from a previous create Cloud Volumes ONTAP action as shown in the example, or from the information page of the Cloud Volumes ONTAP working environment on https://console.bluexp.netapp.com/.
    workingEnvironmentName String
    The working environment name where the aggregate will be created. This argument will be ignored if working_environment_id is provided.

    Supporting Types

    CbsAwsCbsParameters, CbsAwsCbsParametersArgs

    AccessKey string
    ArchiveStorageClass string
    Required for AWS to specify which storage class to use for archiving.
    AwsAccountId string
    Required when the provider is AWS.
    KmsKeyId string
    Input field for a customer-managed key use case
    PrivateEndpointId string
    SecretPassword string
    AccessKey string
    ArchiveStorageClass string
    Required for AWS to specify which storage class to use for archiving.
    AwsAccountId string
    Required when the provider is AWS.
    KmsKeyId string
    Input field for a customer-managed key use case
    PrivateEndpointId string
    SecretPassword string
    accessKey String
    archiveStorageClass String
    Required for AWS to specify which storage class to use for archiving.
    awsAccountId String
    Required when the provider is AWS.
    kmsKeyId String
    Input field for a customer-managed key use case
    privateEndpointId String
    secretPassword String
    accessKey string
    archiveStorageClass string
    Required for AWS to specify which storage class to use for archiving.
    awsAccountId string
    Required when the provider is AWS.
    kmsKeyId string
    Input field for a customer-managed key use case
    privateEndpointId string
    secretPassword string
    access_key str
    archive_storage_class str
    Required for AWS to specify which storage class to use for archiving.
    aws_account_id str
    Required when the provider is AWS.
    kms_key_id str
    Input field for a customer-managed key use case
    private_endpoint_id str
    secret_password str
    accessKey String
    archiveStorageClass String
    Required for AWS to specify which storage class to use for archiving.
    awsAccountId String
    Required when the provider is AWS.
    kmsKeyId String
    Input field for a customer-managed key use case
    privateEndpointId String
    secretPassword String

    CbsAzureCbsParameters, CbsAzureCbsParametersArgs

    KeyName string
    Key vault name.
    KeyVaultId string
    The id can be found with key vault JSON View in Azure. e.g. "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/xxxxxxxxx/providers/Microsoft.KeyVault/vaults/xxxxxx"
    PrivateEndpointId string
    The id can be found with private endpoints with JSON view in Azure.
    ResourceGroup string
    The resource group name.
    StorageAccount string
    The storage account.
    Subscription string
    The subscription ID.
    KeyName string
    Key vault name.
    KeyVaultId string
    The id can be found with key vault JSON View in Azure. e.g. "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/xxxxxxxxx/providers/Microsoft.KeyVault/vaults/xxxxxx"
    PrivateEndpointId string
    The id can be found with private endpoints with JSON view in Azure.
    ResourceGroup string
    The resource group name.
    StorageAccount string
    The storage account.
    Subscription string
    The subscription ID.
    keyName String
    Key vault name.
    keyVaultId String
    The id can be found with key vault JSON View in Azure. e.g. "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/xxxxxxxxx/providers/Microsoft.KeyVault/vaults/xxxxxx"
    privateEndpointId String
    The id can be found with private endpoints with JSON view in Azure.
    resourceGroup String
    The resource group name.
    storageAccount String
    The storage account.
    subscription String
    The subscription ID.
    keyName string
    Key vault name.
    keyVaultId string
    The id can be found with key vault JSON View in Azure. e.g. "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/xxxxxxxxx/providers/Microsoft.KeyVault/vaults/xxxxxx"
    privateEndpointId string
    The id can be found with private endpoints with JSON view in Azure.
    resourceGroup string
    The resource group name.
    storageAccount string
    The storage account.
    subscription string
    The subscription ID.
    key_name str
    Key vault name.
    key_vault_id str
    The id can be found with key vault JSON View in Azure. e.g. "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/xxxxxxxxx/providers/Microsoft.KeyVault/vaults/xxxxxx"
    private_endpoint_id str
    The id can be found with private endpoints with JSON view in Azure.
    resource_group str
    The resource group name.
    storage_account str
    The storage account.
    subscription str
    The subscription ID.
    keyName String
    Key vault name.
    keyVaultId String
    The id can be found with key vault JSON View in Azure. e.g. "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/xxxxxxxxx/providers/Microsoft.KeyVault/vaults/xxxxxx"
    privateEndpointId String
    The id can be found with private endpoints with JSON view in Azure.
    resourceGroup String
    The resource group name.
    storageAccount String
    The storage account.
    subscription String
    The subscription ID.

    CbsBackupPolicy, CbsBackupPolicyArgs

    Name string
    ArchiveAfterDays string
    ObjectLock string
    For AWS, DataLock and Ransomware Protection can be enabled in the "GOVERNANCE" mode or "COMPLIANCE" mode. For Azure, DataLock and Ransomware Protection can be enabled in the "UNLOCKED" mode or "LOCKED" mode.
    PolicyRules List<Pulumi.NetappCloudmanager.Inputs.CbsBackupPolicyPolicyRule>
    Name string
    ArchiveAfterDays string
    ObjectLock string
    For AWS, DataLock and Ransomware Protection can be enabled in the "GOVERNANCE" mode or "COMPLIANCE" mode. For Azure, DataLock and Ransomware Protection can be enabled in the "UNLOCKED" mode or "LOCKED" mode.
    PolicyRules []CbsBackupPolicyPolicyRule
    name String
    archiveAfterDays String
    objectLock String
    For AWS, DataLock and Ransomware Protection can be enabled in the "GOVERNANCE" mode or "COMPLIANCE" mode. For Azure, DataLock and Ransomware Protection can be enabled in the "UNLOCKED" mode or "LOCKED" mode.
    policyRules List<CbsBackupPolicyPolicyRule>
    name string
    archiveAfterDays string
    objectLock string
    For AWS, DataLock and Ransomware Protection can be enabled in the "GOVERNANCE" mode or "COMPLIANCE" mode. For Azure, DataLock and Ransomware Protection can be enabled in the "UNLOCKED" mode or "LOCKED" mode.
    policyRules CbsBackupPolicyPolicyRule[]
    name str
    archive_after_days str
    object_lock str
    For AWS, DataLock and Ransomware Protection can be enabled in the "GOVERNANCE" mode or "COMPLIANCE" mode. For Azure, DataLock and Ransomware Protection can be enabled in the "UNLOCKED" mode or "LOCKED" mode.
    policy_rules Sequence[CbsBackupPolicyPolicyRule]
    name String
    archiveAfterDays String
    objectLock String
    For AWS, DataLock and Ransomware Protection can be enabled in the "GOVERNANCE" mode or "COMPLIANCE" mode. For Azure, DataLock and Ransomware Protection can be enabled in the "UNLOCKED" mode or "LOCKED" mode.
    policyRules List<Property Map>

    CbsBackupPolicyPolicyRule, CbsBackupPolicyPolicyRuleArgs

    CbsBackupPolicyPolicyRuleRule, CbsBackupPolicyPolicyRuleRuleArgs

    Label string
    ['Hourly', 'Daily', 'Weekly', 'Monthly', 'Yearly']
    Retention string
    The number value goes with the label
    Label string
    ['Hourly', 'Daily', 'Weekly', 'Monthly', 'Yearly']
    Retention string
    The number value goes with the label
    label String
    ['Hourly', 'Daily', 'Weekly', 'Monthly', 'Yearly']
    retention String
    The number value goes with the label
    label string
    ['Hourly', 'Daily', 'Weekly', 'Monthly', 'Yearly']
    retention string
    The number value goes with the label
    label str
    ['Hourly', 'Daily', 'Weekly', 'Monthly', 'Yearly']
    retention str
    The number value goes with the label
    label String
    ['Hourly', 'Daily', 'Weekly', 'Monthly', 'Yearly']
    retention String
    The number value goes with the label

    CbsVolume, CbsVolumeArgs

    VolumeName string
    Name of the volume to enable backup.
    BackupPolicy Pulumi.NetappCloudmanager.Inputs.CbsVolumeBackupPolicy
    Mode string
    type of mode to create snapshot copies.
    VolumeName string
    Name of the volume to enable backup.
    BackupPolicy CbsVolumeBackupPolicy
    Mode string
    type of mode to create snapshot copies.
    volumeName String
    Name of the volume to enable backup.
    backupPolicy CbsVolumeBackupPolicy
    mode String
    type of mode to create snapshot copies.
    volumeName string
    Name of the volume to enable backup.
    backupPolicy CbsVolumeBackupPolicy
    mode string
    type of mode to create snapshot copies.
    volume_name str
    Name of the volume to enable backup.
    backup_policy CbsVolumeBackupPolicy
    mode str
    type of mode to create snapshot copies.
    volumeName String
    Name of the volume to enable backup.
    backupPolicy Property Map
    mode String
    type of mode to create snapshot copies.

    CbsVolumeBackupPolicy, CbsVolumeBackupPolicyArgs

    Name string
    ArchiveAfterDays string
    ObjectLock string
    For AWS, DataLock and Ransomware Protection can be enabled in the "GOVERNANCE" mode or "COMPLIANCE" mode. For Azure, DataLock and Ransomware Protection can be enabled in the "UNLOCKED" mode or "LOCKED" mode.
    PolicyRules List<Pulumi.NetappCloudmanager.Inputs.CbsVolumeBackupPolicyPolicyRule>
    Name string
    ArchiveAfterDays string
    ObjectLock string
    For AWS, DataLock and Ransomware Protection can be enabled in the "GOVERNANCE" mode or "COMPLIANCE" mode. For Azure, DataLock and Ransomware Protection can be enabled in the "UNLOCKED" mode or "LOCKED" mode.
    PolicyRules []CbsVolumeBackupPolicyPolicyRule
    name String
    archiveAfterDays String
    objectLock String
    For AWS, DataLock and Ransomware Protection can be enabled in the "GOVERNANCE" mode or "COMPLIANCE" mode. For Azure, DataLock and Ransomware Protection can be enabled in the "UNLOCKED" mode or "LOCKED" mode.
    policyRules List<CbsVolumeBackupPolicyPolicyRule>
    name string
    archiveAfterDays string
    objectLock string
    For AWS, DataLock and Ransomware Protection can be enabled in the "GOVERNANCE" mode or "COMPLIANCE" mode. For Azure, DataLock and Ransomware Protection can be enabled in the "UNLOCKED" mode or "LOCKED" mode.
    policyRules CbsVolumeBackupPolicyPolicyRule[]
    name str
    archive_after_days str
    object_lock str
    For AWS, DataLock and Ransomware Protection can be enabled in the "GOVERNANCE" mode or "COMPLIANCE" mode. For Azure, DataLock and Ransomware Protection can be enabled in the "UNLOCKED" mode or "LOCKED" mode.
    policy_rules Sequence[CbsVolumeBackupPolicyPolicyRule]
    name String
    archiveAfterDays String
    objectLock String
    For AWS, DataLock and Ransomware Protection can be enabled in the "GOVERNANCE" mode or "COMPLIANCE" mode. For Azure, DataLock and Ransomware Protection can be enabled in the "UNLOCKED" mode or "LOCKED" mode.
    policyRules List<Property Map>

    CbsVolumeBackupPolicyPolicyRule, CbsVolumeBackupPolicyPolicyRuleArgs

    CbsVolumeBackupPolicyPolicyRuleRule, CbsVolumeBackupPolicyPolicyRuleRuleArgs

    Label string
    ['Hourly', 'Daily', 'Weekly', 'Monthly', 'Yearly']
    Retention string
    The number value goes with the label
    Label string
    ['Hourly', 'Daily', 'Weekly', 'Monthly', 'Yearly']
    Retention string
    The number value goes with the label
    label String
    ['Hourly', 'Daily', 'Weekly', 'Monthly', 'Yearly']
    retention String
    The number value goes with the label
    label string
    ['Hourly', 'Daily', 'Weekly', 'Monthly', 'Yearly']
    retention string
    The number value goes with the label
    label str
    ['Hourly', 'Daily', 'Weekly', 'Monthly', 'Yearly']
    retention str
    The number value goes with the label
    label String
    ['Hourly', 'Daily', 'Weekly', 'Monthly', 'Yearly']
    retention String
    The number value goes with the label

    Package Details

    Repository
    netapp-cloudmanager netapp/terraform-provider-netapp-cloudmanager
    License
    Notes
    This Pulumi package is based on the netapp-cloudmanager Terraform Provider.
    netapp-cloudmanager logo
    netapp-cloudmanager 25.3.0 published on Monday, Apr 14, 2025 by netapp
    netapp/terraform-provider-netapp-cloudmanager