VolumeCopy class
Creates a copy of an existing Amazon EBS volume.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const source = new aws.ebs.Volume("source", {
availabilityZone: "us-west-2a",
size: 8,
});
const example = new aws.ebs.VolumeCopy("example", {
sourceVolumeId: source.id,
volumeType: "gp3",
size: 20,
iops: 3000,
throughput: 125,
tags: {
Name: "example-copy",
},
});
import pulumi
import pulumi_aws as aws
source = aws.ebs.Volume("source",
availability_zone="us-west-2a",
size=8)
example = aws.ebs.VolumeCopy("example",
source_volume_id=source.id,
volume_type="gp3",
size=20,
iops=3000,
throughput=125,
tags={
"Name": "example-copy",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var source = new Aws.Ebs.Volume("source", new()
{
AvailabilityZone = "us-west-2a",
Size = 8,
});
var example = new Aws.Ebs.VolumeCopy("example", new()
{
SourceVolumeId = source.Id,
VolumeType = "gp3",
Size = 20,
Iops = 3000,
Throughput = 125,
Tags =
{
{ "Name", "example-copy" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ebs"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
source, err := ebs.NewVolume(ctx, "source", &ebs.VolumeArgs{
AvailabilityZone: pulumi.String("us-west-2a"),
Size: pulumi.Int(8),
})
if err != nil {
return err
}
_, err = ebs.NewVolumeCopy(ctx, "example", &ebs.VolumeCopyArgs{
SourceVolumeId: source.ID().ToIDOutput().ToStringOutput(),
VolumeType: pulumi.String("gp3"),
Size: pulumi.Int(20),
Iops: pulumi.Int(3000),
Throughput: pulumi.Int(125),
Tags: pulumi.StringMap{
"Name": pulumi.String("example-copy"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_ebs_volume" "source" {
availability_zone = "us-west-2a"
size = 8
}
resource "aws_ebs_volumecopy" "example" {
source_volume_id = aws_ebs_volume.source.id
volume_type = "gp3"
size = 20
iops = 3000
throughput = 125
tags = {
"Name" = "example-copy"
}
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ebs.Volume;
import com.pulumi.aws.ebs.VolumeArgs;
import com.pulumi.aws.ebs.VolumeCopy;
import com.pulumi.aws.ebs.VolumeCopyArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 source = new Volume("source", VolumeArgs.builder()
.availabilityZone("us-west-2a")
.size(8)
.build());
var example = new VolumeCopy("example", VolumeCopyArgs.builder()
.sourceVolumeId(source.id())
.volumeType("gp3")
.size(20)
.iops(3000)
.throughput(125)
.tags(Map.of("Name", "example-copy"))
.build());
}
}
resources:
source:
type: aws:ebs:Volume
properties:
availabilityZone: us-west-2a
size: 8
example:
type: aws:ebs:VolumeCopy
properties:
sourceVolumeId: ${source.id}
volumeType: gp3
size: 20
iops: 3000
throughput: 125
tags:
Name: example-copy
Import
Identity Schema
Required
id(String) Volume ID.
Optional
accountId(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
Using pulumi import, import an EBS Volume Copy using the volume ID. For example:
$ pulumi import aws:ebs/volumeCopy:VolumeCopy example vol-049df61146c4d7901
Constructors
- VolumeCopy(String name, {VolumeCopyArgs? args, CustomResourceOptions? options})
-
Creates a new VolumeCopy.
nameThe Pulumi resource name.argsArguments used to configure this VolumeCopy. The set of arguments for VolumeCopy.optionsResource options controlling this resource's behavior. - VolumeCopy.reference(String urn)
- Creates a typed reference to an existing VolumeCopy resource.
Properties
-
arn
↔ Output<
String> -
ARN of the copied EBS volume.
latefinal
-
availabilityZone
↔ Output<
String> -
Availability Zone for the copied volume.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
-
iops
↔ Output<
int> -
Provisioned IOPS for the copied volume. Use only with volume types that support provisioned IOPS, such as
gp3.latefinal - isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration. This must match the Region of the source EBS volume referenced by
sourceVolumeId.latefinal -
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
size
↔ Output<
int> -
Size of the copied volume, in GiB.
latefinal
-
sourceVolumeId
↔ Output<
String> -
ID of the source EBS volume to copy. Changing this value forces replacement of the resource.
latefinal
-
A map of tags to assign to the copied volume. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
throughput
↔ Output<
int> -
Throughput for the copied volume, in MiB/s. Valid only when
volumeTypeisgp3.latefinal -
timeouts
↔ Output<
VolumeCopyTimeouts?> -
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
volumeType
↔ Output<
String> -
Type of the copied EBS volume. Valid values include
gp2,gp3,io1,io2,sc1,st1, andstandard.latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {VolumeCopyState? state, CustomResourceOptions? options}) → VolumeCopy -
Gets an existing VolumeCopy resource's state with the given
nameandid.