aws.fsx.OpenZfsSnapshot
Explore with Pulumi AI
Manages an Amazon FSx for OpenZFS volume. See the FSx OpenZFS User Guide for more information.
Example Usage
Root volume Example
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const exampleOpenZfsFileSystem = new aws.fsx.OpenZfsFileSystem("example", {
storageCapacity: 64,
subnetIds: [exampleAwsSubnet.id],
deploymentType: "SINGLE_AZ_1",
throughputCapacity: 64,
});
const example = new aws.fsx.OpenZfsSnapshot("example", {
name: "example",
volumeId: exampleOpenZfsFileSystem.rootVolumeId,
});
import pulumi
import pulumi_aws as aws
example_open_zfs_file_system = aws.fsx.OpenZfsFileSystem("example",
storage_capacity=64,
subnet_ids=[example_aws_subnet["id"]],
deployment_type="SINGLE_AZ_1",
throughput_capacity=64)
example = aws.fsx.OpenZfsSnapshot("example",
name="example",
volume_id=example_open_zfs_file_system.root_volume_id)
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/fsx"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleOpenZfsFileSystem, err := fsx.NewOpenZfsFileSystem(ctx, "example", &fsx.OpenZfsFileSystemArgs{
StorageCapacity: pulumi.Int(64),
SubnetIds: pulumi.StringArray{
exampleAwsSubnet.Id,
},
DeploymentType: pulumi.String("SINGLE_AZ_1"),
ThroughputCapacity: pulumi.Int(64),
})
if err != nil {
return err
}
_, err = fsx.NewOpenZfsSnapshot(ctx, "example", &fsx.OpenZfsSnapshotArgs{
Name: pulumi.String("example"),
VolumeId: exampleOpenZfsFileSystem.RootVolumeId,
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var exampleOpenZfsFileSystem = new Aws.Fsx.OpenZfsFileSystem("example", new()
{
StorageCapacity = 64,
SubnetIds = new[]
{
exampleAwsSubnet.Id,
},
DeploymentType = "SINGLE_AZ_1",
ThroughputCapacity = 64,
});
var example = new Aws.Fsx.OpenZfsSnapshot("example", new()
{
Name = "example",
VolumeId = exampleOpenZfsFileSystem.RootVolumeId,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.fsx.OpenZfsFileSystem;
import com.pulumi.aws.fsx.OpenZfsFileSystemArgs;
import com.pulumi.aws.fsx.OpenZfsSnapshot;
import com.pulumi.aws.fsx.OpenZfsSnapshotArgs;
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 exampleOpenZfsFileSystem = new OpenZfsFileSystem("exampleOpenZfsFileSystem", OpenZfsFileSystemArgs.builder()
.storageCapacity(64)
.subnetIds(exampleAwsSubnet.id())
.deploymentType("SINGLE_AZ_1")
.throughputCapacity(64)
.build());
var example = new OpenZfsSnapshot("example", OpenZfsSnapshotArgs.builder()
.name("example")
.volumeId(exampleOpenZfsFileSystem.rootVolumeId())
.build());
}
}
resources:
example:
type: aws:fsx:OpenZfsSnapshot
properties:
name: example
volumeId: ${exampleOpenZfsFileSystem.rootVolumeId}
exampleOpenZfsFileSystem:
type: aws:fsx:OpenZfsFileSystem
name: example
properties:
storageCapacity: 64
subnetIds:
- ${exampleAwsSubnet.id}
deploymentType: SINGLE_AZ_1
throughputCapacity: 64
Child volume Example
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const exampleOpenZfsFileSystem = new aws.fsx.OpenZfsFileSystem("example", {
storageCapacity: 64,
subnetIds: [exampleAwsSubnet.id],
deploymentType: "SINGLE_AZ_1",
throughputCapacity: 64,
});
const exampleOpenZfsVolume = new aws.fsx.OpenZfsVolume("example", {
name: "example",
parentVolumeId: exampleOpenZfsFileSystem.rootVolumeId,
});
const example = new aws.fsx.OpenZfsSnapshot("example", {
name: "example",
volumeId: exampleOpenZfsVolume.id,
});
import pulumi
import pulumi_aws as aws
example_open_zfs_file_system = aws.fsx.OpenZfsFileSystem("example",
storage_capacity=64,
subnet_ids=[example_aws_subnet["id"]],
deployment_type="SINGLE_AZ_1",
throughput_capacity=64)
example_open_zfs_volume = aws.fsx.OpenZfsVolume("example",
name="example",
parent_volume_id=example_open_zfs_file_system.root_volume_id)
example = aws.fsx.OpenZfsSnapshot("example",
name="example",
volume_id=example_open_zfs_volume.id)
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/fsx"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleOpenZfsFileSystem, err := fsx.NewOpenZfsFileSystem(ctx, "example", &fsx.OpenZfsFileSystemArgs{
StorageCapacity: pulumi.Int(64),
SubnetIds: pulumi.StringArray{
exampleAwsSubnet.Id,
},
DeploymentType: pulumi.String("SINGLE_AZ_1"),
ThroughputCapacity: pulumi.Int(64),
})
if err != nil {
return err
}
exampleOpenZfsVolume, err := fsx.NewOpenZfsVolume(ctx, "example", &fsx.OpenZfsVolumeArgs{
Name: pulumi.String("example"),
ParentVolumeId: exampleOpenZfsFileSystem.RootVolumeId,
})
if err != nil {
return err
}
_, err = fsx.NewOpenZfsSnapshot(ctx, "example", &fsx.OpenZfsSnapshotArgs{
Name: pulumi.String("example"),
VolumeId: exampleOpenZfsVolume.ID(),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var exampleOpenZfsFileSystem = new Aws.Fsx.OpenZfsFileSystem("example", new()
{
StorageCapacity = 64,
SubnetIds = new[]
{
exampleAwsSubnet.Id,
},
DeploymentType = "SINGLE_AZ_1",
ThroughputCapacity = 64,
});
var exampleOpenZfsVolume = new Aws.Fsx.OpenZfsVolume("example", new()
{
Name = "example",
ParentVolumeId = exampleOpenZfsFileSystem.RootVolumeId,
});
var example = new Aws.Fsx.OpenZfsSnapshot("example", new()
{
Name = "example",
VolumeId = exampleOpenZfsVolume.Id,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.fsx.OpenZfsFileSystem;
import com.pulumi.aws.fsx.OpenZfsFileSystemArgs;
import com.pulumi.aws.fsx.OpenZfsVolume;
import com.pulumi.aws.fsx.OpenZfsVolumeArgs;
import com.pulumi.aws.fsx.OpenZfsSnapshot;
import com.pulumi.aws.fsx.OpenZfsSnapshotArgs;
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 exampleOpenZfsFileSystem = new OpenZfsFileSystem("exampleOpenZfsFileSystem", OpenZfsFileSystemArgs.builder()
.storageCapacity(64)
.subnetIds(exampleAwsSubnet.id())
.deploymentType("SINGLE_AZ_1")
.throughputCapacity(64)
.build());
var exampleOpenZfsVolume = new OpenZfsVolume("exampleOpenZfsVolume", OpenZfsVolumeArgs.builder()
.name("example")
.parentVolumeId(exampleOpenZfsFileSystem.rootVolumeId())
.build());
var example = new OpenZfsSnapshot("example", OpenZfsSnapshotArgs.builder()
.name("example")
.volumeId(exampleOpenZfsVolume.id())
.build());
}
}
resources:
example:
type: aws:fsx:OpenZfsSnapshot
properties:
name: example
volumeId: ${exampleOpenZfsVolume.id}
exampleOpenZfsVolume:
type: aws:fsx:OpenZfsVolume
name: example
properties:
name: example
parentVolumeId: ${exampleOpenZfsFileSystem.rootVolumeId}
exampleOpenZfsFileSystem:
type: aws:fsx:OpenZfsFileSystem
name: example
properties:
storageCapacity: 64
subnetIds:
- ${exampleAwsSubnet.id}
deploymentType: SINGLE_AZ_1
throughputCapacity: 64
Create OpenZfsSnapshot Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new OpenZfsSnapshot(name: string, args: OpenZfsSnapshotArgs, opts?: CustomResourceOptions);
@overload
def OpenZfsSnapshot(resource_name: str,
args: OpenZfsSnapshotArgs,
opts: Optional[ResourceOptions] = None)
@overload
def OpenZfsSnapshot(resource_name: str,
opts: Optional[ResourceOptions] = None,
volume_id: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
func NewOpenZfsSnapshot(ctx *Context, name string, args OpenZfsSnapshotArgs, opts ...ResourceOption) (*OpenZfsSnapshot, error)
public OpenZfsSnapshot(string name, OpenZfsSnapshotArgs args, CustomResourceOptions? opts = null)
public OpenZfsSnapshot(String name, OpenZfsSnapshotArgs args)
public OpenZfsSnapshot(String name, OpenZfsSnapshotArgs args, CustomResourceOptions options)
type: aws:fsx:OpenZfsSnapshot
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 OpenZfsSnapshotArgs
- 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 OpenZfsSnapshotArgs
- 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 OpenZfsSnapshotArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args OpenZfsSnapshotArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args OpenZfsSnapshotArgs
- 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 openZfsSnapshotResource = new Aws.Fsx.OpenZfsSnapshot("openZfsSnapshotResource", new()
{
VolumeId = "string",
Name = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := fsx.NewOpenZfsSnapshot(ctx, "openZfsSnapshotResource", &fsx.OpenZfsSnapshotArgs{
VolumeId: pulumi.String("string"),
Name: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var openZfsSnapshotResource = new OpenZfsSnapshot("openZfsSnapshotResource", OpenZfsSnapshotArgs.builder()
.volumeId("string")
.name("string")
.tags(Map.of("string", "string"))
.build());
open_zfs_snapshot_resource = aws.fsx.OpenZfsSnapshot("openZfsSnapshotResource",
volume_id="string",
name="string",
tags={
"string": "string",
})
const openZfsSnapshotResource = new aws.fsx.OpenZfsSnapshot("openZfsSnapshotResource", {
volumeId: "string",
name: "string",
tags: {
string: "string",
},
});
type: aws:fsx:OpenZfsSnapshot
properties:
name: string
tags:
string: string
volumeId: string
OpenZfsSnapshot 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 OpenZfsSnapshot resource accepts the following input properties:
- Volume
Id string - The ID of the volume to snapshot. This can be the root volume or a child volume.
- Name string
- The name of the Snapshot. You can use a maximum of 203 alphanumeric characters plus either _ or - or : or . for the name.
- Dictionary<string, string>
- A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have setcopy_tags_to_backups
to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup.
- Volume
Id string - The ID of the volume to snapshot. This can be the root volume or a child volume.
- Name string
- The name of the Snapshot. You can use a maximum of 203 alphanumeric characters plus either _ or - or : or . for the name.
- map[string]string
- A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have setcopy_tags_to_backups
to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup.
- volume
Id String - The ID of the volume to snapshot. This can be the root volume or a child volume.
- name String
- The name of the Snapshot. You can use a maximum of 203 alphanumeric characters plus either _ or - or : or . for the name.
- Map<String,String>
- A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have setcopy_tags_to_backups
to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup.
- volume
Id string - The ID of the volume to snapshot. This can be the root volume or a child volume.
- name string
- The name of the Snapshot. You can use a maximum of 203 alphanumeric characters plus either _ or - or : or . for the name.
- {[key: string]: string}
- A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have setcopy_tags_to_backups
to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup.
- volume_
id str - The ID of the volume to snapshot. This can be the root volume or a child volume.
- name str
- The name of the Snapshot. You can use a maximum of 203 alphanumeric characters plus either _ or - or : or . for the name.
- Mapping[str, str]
- A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have setcopy_tags_to_backups
to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup.
- volume
Id String - The ID of the volume to snapshot. This can be the root volume or a child volume.
- name String
- The name of the Snapshot. You can use a maximum of 203 alphanumeric characters plus either _ or - or : or . for the name.
- Map<String>
- A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have setcopy_tags_to_backups
to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup.
Outputs
All input properties are implicitly available as output properties. Additionally, the OpenZfsSnapshot resource produces the following output properties:
- Arn string
- Amazon Resource Name of the snapshot.
- Creation
Time string - Id string
- The provider-assigned unique ID for this managed resource.
- Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- Arn string
- Amazon Resource Name of the snapshot.
- Creation
Time string - Id string
- The provider-assigned unique ID for this managed resource.
- map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- Amazon Resource Name of the snapshot.
- creation
Time String - id String
- The provider-assigned unique ID for this managed resource.
- Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn string
- Amazon Resource Name of the snapshot.
- creation
Time string - id string
- The provider-assigned unique ID for this managed resource.
- {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn str
- Amazon Resource Name of the snapshot.
- creation_
time str - id str
- The provider-assigned unique ID for this managed resource.
- Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- Amazon Resource Name of the snapshot.
- creation
Time String - id String
- The provider-assigned unique ID for this managed resource.
- Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
Look up Existing OpenZfsSnapshot Resource
Get an existing OpenZfsSnapshot 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?: OpenZfsSnapshotState, opts?: CustomResourceOptions): OpenZfsSnapshot
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
creation_time: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
volume_id: Optional[str] = None) -> OpenZfsSnapshot
func GetOpenZfsSnapshot(ctx *Context, name string, id IDInput, state *OpenZfsSnapshotState, opts ...ResourceOption) (*OpenZfsSnapshot, error)
public static OpenZfsSnapshot Get(string name, Input<string> id, OpenZfsSnapshotState? state, CustomResourceOptions? opts = null)
public static OpenZfsSnapshot get(String name, Output<String> id, OpenZfsSnapshotState 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.
- Arn string
- Amazon Resource Name of the snapshot.
- Creation
Time string - Name string
- The name of the Snapshot. You can use a maximum of 203 alphanumeric characters plus either _ or - or : or . for the name.
- Dictionary<string, string>
- A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have setcopy_tags_to_backups
to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup. - Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Volume
Id string - The ID of the volume to snapshot. This can be the root volume or a child volume.
- Arn string
- Amazon Resource Name of the snapshot.
- Creation
Time string - Name string
- The name of the Snapshot. You can use a maximum of 203 alphanumeric characters plus either _ or - or : or . for the name.
- map[string]string
- A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have setcopy_tags_to_backups
to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup. - map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Volume
Id string - The ID of the volume to snapshot. This can be the root volume or a child volume.
- arn String
- Amazon Resource Name of the snapshot.
- creation
Time String - name String
- The name of the Snapshot. You can use a maximum of 203 alphanumeric characters plus either _ or - or : or . for the name.
- Map<String,String>
- A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have setcopy_tags_to_backups
to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup. - Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - volume
Id String - The ID of the volume to snapshot. This can be the root volume or a child volume.
- arn string
- Amazon Resource Name of the snapshot.
- creation
Time string - name string
- The name of the Snapshot. You can use a maximum of 203 alphanumeric characters plus either _ or - or : or . for the name.
- {[key: string]: string}
- A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have setcopy_tags_to_backups
to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup. - {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - volume
Id string - The ID of the volume to snapshot. This can be the root volume or a child volume.
- arn str
- Amazon Resource Name of the snapshot.
- creation_
time str - name str
- The name of the Snapshot. You can use a maximum of 203 alphanumeric characters plus either _ or - or : or . for the name.
- Mapping[str, str]
- A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have setcopy_tags_to_backups
to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup. - Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - volume_
id str - The ID of the volume to snapshot. This can be the root volume or a child volume.
- arn String
- Amazon Resource Name of the snapshot.
- creation
Time String - name String
- The name of the Snapshot. You can use a maximum of 203 alphanumeric characters plus either _ or - or : or . for the name.
- Map<String>
- A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have setcopy_tags_to_backups
to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup. - Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - volume
Id String - The ID of the volume to snapshot. This can be the root volume or a child volume.
Import
Using pulumi import
, import FSx OpenZFS snapshot using the id
. For example:
$ pulumi import aws:fsx/openZfsSnapshot:OpenZfsSnapshot example fs-543ab12b1ca672f33
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.