Docs Packages
  1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. CloudBackupSnapshotExportBucket
MongoDB Atlas v3.16.2 published on Friday, Jun 21, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.CloudBackupSnapshotExportBucket

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.16.2 published on Friday, Jun 21, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

    mongodbatlas.CloudBackupSnapshotExportBucket resource allows you to create an export snapshot bucket for the specified project.

    NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const test = new mongodbatlas.CloudBackupSnapshotExportBucket("test", {
    projectId: "{PROJECT_ID}",
    iamRoleId: "{IAM_ROLE_ID}",
    bucketName: "example-bucket",
    cloudProvider: "AWS",
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.CloudBackupSnapshotExportBucket("test",
    project_id="{PROJECT_ID}",
    iam_role_id="{IAM_ROLE_ID}",
    bucket_name="example-bucket",
    cloud_provider="AWS")

    package main

import (
	"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mongodbatlas.NewCloudBackupSnapshotExportBucket(ctx, "test", &mongodbatlas.CloudBackupSnapshotExportBucketArgs{
			ProjectId:     pulumi.String("{PROJECT_ID}"),
			IamRoleId:     pulumi.String("{IAM_ROLE_ID}"),
			BucketName:    pulumi.String("example-bucket"),
			CloudProvider: pulumi.String("AWS"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var test = new Mongodbatlas.CloudBackupSnapshotExportBucket("test", new()
    {
        ProjectId = "{PROJECT_ID}",
        IamRoleId = "{IAM_ROLE_ID}",
        BucketName = "example-bucket",
        CloudProvider = "AWS",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.CloudBackupSnapshotExportBucket;
import com.pulumi.mongodbatlas.CloudBackupSnapshotExportBucketArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new CloudBackupSnapshotExportBucket("test", CloudBackupSnapshotExportBucketArgs.builder()
            .projectId("{PROJECT_ID}")
            .iamRoleId("{IAM_ROLE_ID}")
            .bucketName("example-bucket")
            .cloudProvider("AWS")
            .build());

    }
}

    resources:
  test:
    type: mongodbatlas:CloudBackupSnapshotExportBucket
    properties:
      projectId: '{PROJECT_ID}'
      iamRoleId: '{IAM_ROLE_ID}'
      bucketName: example-bucket
      cloudProvider: AWS

    Create CloudBackupSnapshotExportBucket Resource

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

    Constructor syntax

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

@overload
def CloudBackupSnapshotExportBucket(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    bucket_name: Optional[str] = None,
                                    cloud_provider: Optional[str] = None,
                                    iam_role_id: Optional[str] = None,
                                    project_id: Optional[str] = None)
    func NewCloudBackupSnapshotExportBucket(ctx *Context, name string, args CloudBackupSnapshotExportBucketArgs, opts ...ResourceOption) (*CloudBackupSnapshotExportBucket, error)
    public CloudBackupSnapshotExportBucket(string name, CloudBackupSnapshotExportBucketArgs args, CustomResourceOptions? opts = null)
    public CloudBackupSnapshotExportBucket(String name, CloudBackupSnapshotExportBucketArgs args)
public CloudBackupSnapshotExportBucket(String name, CloudBackupSnapshotExportBucketArgs args, CustomResourceOptions options)

    type: mongodbatlas:CloudBackupSnapshotExportBucket
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 CloudBackupSnapshotExportBucketArgs
    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 CloudBackupSnapshotExportBucketArgs
    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 CloudBackupSnapshotExportBucketArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CloudBackupSnapshotExportBucketArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CloudBackupSnapshotExportBucketArgs
    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 cloudBackupSnapshotExportBucketResource = new Mongodbatlas.CloudBackupSnapshotExportBucket("cloudBackupSnapshotExportBucketResource", new()
{
    BucketName = "string",
    CloudProvider = "string",
    IamRoleId = "string",
    ProjectId = "string",
});

    example, err := mongodbatlas.NewCloudBackupSnapshotExportBucket(ctx, "cloudBackupSnapshotExportBucketResource", &mongodbatlas.CloudBackupSnapshotExportBucketArgs{
	BucketName:    pulumi.String("string"),
	CloudProvider: pulumi.String("string"),
	IamRoleId:     pulumi.String("string"),
	ProjectId:     pulumi.String("string"),
})

    var cloudBackupSnapshotExportBucketResource = new CloudBackupSnapshotExportBucket("cloudBackupSnapshotExportBucketResource", CloudBackupSnapshotExportBucketArgs.builder()
    .bucketName("string")
    .cloudProvider("string")
    .iamRoleId("string")
    .projectId("string")
    .build());

    cloud_backup_snapshot_export_bucket_resource = mongodbatlas.CloudBackupSnapshotExportBucket("cloudBackupSnapshotExportBucketResource",
    bucket_name="string",
    cloud_provider="string",
    iam_role_id="string",
    project_id="string")

    const cloudBackupSnapshotExportBucketResource = new mongodbatlas.CloudBackupSnapshotExportBucket("cloudBackupSnapshotExportBucketResource", {
    bucketName: "string",
    cloudProvider: "string",
    iamRoleId: "string",
    projectId: "string",
});

    type: mongodbatlas:CloudBackupSnapshotExportBucket
properties:
    bucketName: string
    cloudProvider: string
    iamRoleId: string
    projectId: string

    CloudBackupSnapshotExportBucket 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 CloudBackupSnapshotExportBucket resource accepts the following input properties:

    BucketName string
    Name of the bucket that the provided role ID is authorized to access. You must also specify the iam_role_id.
    CloudProvider string
    Name of the provider of the cloud service where Atlas can access the S3 bucket. Atlas only supports AWS.
    IamRoleId string
    Unique identifier of the role that Atlas can use to access the bucket. You must also specify the bucket_name.
    ProjectId string
    The unique identifier of the project for the Atlas cluster.
    BucketName string
    Name of the bucket that the provided role ID is authorized to access. You must also specify the iam_role_id.
    CloudProvider string
    Name of the provider of the cloud service where Atlas can access the S3 bucket. Atlas only supports AWS.
    IamRoleId string
    Unique identifier of the role that Atlas can use to access the bucket. You must also specify the bucket_name.
    ProjectId string
    The unique identifier of the project for the Atlas cluster.
    bucketName String
    Name of the bucket that the provided role ID is authorized to access. You must also specify the iam_role_id.
    cloudProvider String
    Name of the provider of the cloud service where Atlas can access the S3 bucket. Atlas only supports AWS.
    iamRoleId String
    Unique identifier of the role that Atlas can use to access the bucket. You must also specify the bucket_name.
    projectId String
    The unique identifier of the project for the Atlas cluster.
    bucketName string
    Name of the bucket that the provided role ID is authorized to access. You must also specify the iam_role_id.
    cloudProvider string
    Name of the provider of the cloud service where Atlas can access the S3 bucket. Atlas only supports AWS.
    iamRoleId string
    Unique identifier of the role that Atlas can use to access the bucket. You must also specify the bucket_name.
    projectId string
    The unique identifier of the project for the Atlas cluster.
    bucket_name str
    Name of the bucket that the provided role ID is authorized to access. You must also specify the iam_role_id.
    cloud_provider str
    Name of the provider of the cloud service where Atlas can access the S3 bucket. Atlas only supports AWS.
    iam_role_id str
    Unique identifier of the role that Atlas can use to access the bucket. You must also specify the bucket_name.
    project_id str
    The unique identifier of the project for the Atlas cluster.
    bucketName String
    Name of the bucket that the provided role ID is authorized to access. You must also specify the iam_role_id.
    cloudProvider String
    Name of the provider of the cloud service where Atlas can access the S3 bucket. Atlas only supports AWS.
    iamRoleId String
    Unique identifier of the role that Atlas can use to access the bucket. You must also specify the bucket_name.
    projectId String
    The unique identifier of the project for the Atlas cluster.

    Outputs

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

    ExportBucketId string
    Unique identifier of the snapshot export bucket.
    Id string
    The provider-assigned unique ID for this managed resource.
    ExportBucketId string
    Unique identifier of the snapshot export bucket.
    Id string
    The provider-assigned unique ID for this managed resource.
    exportBucketId String
    Unique identifier of the snapshot export bucket.
    id String
    The provider-assigned unique ID for this managed resource.
    exportBucketId string
    Unique identifier of the snapshot export bucket.
    id string
    The provider-assigned unique ID for this managed resource.
    export_bucket_id str
    Unique identifier of the snapshot export bucket.
    id str
    The provider-assigned unique ID for this managed resource.
    exportBucketId String
    Unique identifier of the snapshot export bucket.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing CloudBackupSnapshotExportBucket Resource

    Get an existing CloudBackupSnapshotExportBucket 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?: CloudBackupSnapshotExportBucketState, opts?: CustomResourceOptions): CloudBackupSnapshotExportBucket
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bucket_name: Optional[str] = None,
        cloud_provider: Optional[str] = None,
        export_bucket_id: Optional[str] = None,
        iam_role_id: Optional[str] = None,
        project_id: Optional[str] = None) -> CloudBackupSnapshotExportBucket
    func GetCloudBackupSnapshotExportBucket(ctx *Context, name string, id IDInput, state *CloudBackupSnapshotExportBucketState, opts ...ResourceOption) (*CloudBackupSnapshotExportBucket, error)
    public static CloudBackupSnapshotExportBucket Get(string name, Input<string> id, CloudBackupSnapshotExportBucketState? state, CustomResourceOptions? opts = null)
    public static CloudBackupSnapshotExportBucket get(String name, Output<String> id, CloudBackupSnapshotExportBucketState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    BucketName string
    Name of the bucket that the provided role ID is authorized to access. You must also specify the iam_role_id.
    CloudProvider string
    Name of the provider of the cloud service where Atlas can access the S3 bucket. Atlas only supports AWS.
    ExportBucketId string
    Unique identifier of the snapshot export bucket.
    IamRoleId string
    Unique identifier of the role that Atlas can use to access the bucket. You must also specify the bucket_name.
    ProjectId string
    The unique identifier of the project for the Atlas cluster.
    BucketName string
    Name of the bucket that the provided role ID is authorized to access. You must also specify the iam_role_id.
    CloudProvider string
    Name of the provider of the cloud service where Atlas can access the S3 bucket. Atlas only supports AWS.
    ExportBucketId string
    Unique identifier of the snapshot export bucket.
    IamRoleId string
    Unique identifier of the role that Atlas can use to access the bucket. You must also specify the bucket_name.
    ProjectId string
    The unique identifier of the project for the Atlas cluster.
    bucketName String
    Name of the bucket that the provided role ID is authorized to access. You must also specify the iam_role_id.
    cloudProvider String
    Name of the provider of the cloud service where Atlas can access the S3 bucket. Atlas only supports AWS.
    exportBucketId String
    Unique identifier of the snapshot export bucket.
    iamRoleId String
    Unique identifier of the role that Atlas can use to access the bucket. You must also specify the bucket_name.
    projectId String
    The unique identifier of the project for the Atlas cluster.
    bucketName string
    Name of the bucket that the provided role ID is authorized to access. You must also specify the iam_role_id.
    cloudProvider string
    Name of the provider of the cloud service where Atlas can access the S3 bucket. Atlas only supports AWS.
    exportBucketId string
    Unique identifier of the snapshot export bucket.
    iamRoleId string
    Unique identifier of the role that Atlas can use to access the bucket. You must also specify the bucket_name.
    projectId string
    The unique identifier of the project for the Atlas cluster.
    bucket_name str
    Name of the bucket that the provided role ID is authorized to access. You must also specify the iam_role_id.
    cloud_provider str
    Name of the provider of the cloud service where Atlas can access the S3 bucket. Atlas only supports AWS.
    export_bucket_id str
    Unique identifier of the snapshot export bucket.
    iam_role_id str
    Unique identifier of the role that Atlas can use to access the bucket. You must also specify the bucket_name.
    project_id str
    The unique identifier of the project for the Atlas cluster.
    bucketName String
    Name of the bucket that the provided role ID is authorized to access. You must also specify the iam_role_id.
    cloudProvider String
    Name of the provider of the cloud service where Atlas can access the S3 bucket. Atlas only supports AWS.
    exportBucketId String
    Unique identifier of the snapshot export bucket.
    iamRoleId String
    Unique identifier of the role that Atlas can use to access the bucket. You must also specify the bucket_name.
    projectId String
    The unique identifier of the project for the Atlas cluster.

    Import

    Cloud Backup Snapshot Export Backup entries can be imported using project project_id, and bucket_id (Unique identifier of the snapshot export bucket), in the format PROJECTID-BUCKETID, e.g.

    $ pulumi import mongodbatlas:index/cloudBackupSnapshotExportBucket:CloudBackupSnapshotExportBucket test 5d0f1f73cf09a29120e173cf-5d116d82014b764445b2f9b5

    For more information see: MongoDB Atlas API Reference.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo
    MongoDB Atlas v3.16.2 published on Friday, Jun 21, 2024 by Pulumi
    pulumi/pulumi-mongodbatlas