Package com.pulumi.aws.storagegateway

Class StoredIscsiVolume

  • public class StoredIscsiVolume
extends com.pulumi.resources.CustomResource
    Manages an AWS Storage Gateway stored iSCSI volume. > **NOTE:** The gateway must have a working storage added (e.g., via the `aws.storagegateway.WorkingStorage` resource) before the volume is operational to clients, however the Storage Gateway API will allow volume creation without error in that case and return volume status as `WORKING STORAGE NOT CONFIGURED`. ## Example Usage ### Create Empty Stored iSCSI Volume 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.storagegateway.StoredIscsiVolume;
 import com.pulumi.aws.storagegateway.StoredIscsiVolumeArgs;
 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 example = new StoredIscsiVolume("example", StoredIscsiVolumeArgs.builder()
             .gatewayArn(exampleAwsStoragegatewayCache.gatewayArn())
             .networkInterfaceId(exampleAwsInstance.privateIp())
             .targetName("example")
             .preserveExistingData(false)
             .diskId(test.id())
             .build());
 
     }
 }
    ### Create Stored iSCSI Volume From Snapshot 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.storagegateway.StoredIscsiVolume;
 import com.pulumi.aws.storagegateway.StoredIscsiVolumeArgs;
 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 example = new StoredIscsiVolume("example", StoredIscsiVolumeArgs.builder()
             .gatewayArn(exampleAwsStoragegatewayCache.gatewayArn())
             .networkInterfaceId(exampleAwsInstance.privateIp())
             .snapshotId(exampleAwsEbsSnapshot.id())
             .targetName("example")
             .preserveExistingData(false)
             .diskId(test.id())
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import `aws.storagegateway.StoredIscsiVolume` using the volume ARN. For example: ```sh $ pulumi import aws:storagegateway/storedIscsiVolume:StoredIscsiVolume example arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678 ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.Boolean> chapEnabled()  
      com.pulumi.core.Output<java.lang.String> diskId()  
      com.pulumi.core.Output<java.lang.String> gatewayArn()  
      static StoredIscsiVolume get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, StoredIscsiVolumeState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> kmsEncrypted()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> kmsKey()  
      com.pulumi.core.Output<java.lang.Integer> lunNumber()  
      com.pulumi.core.Output<java.lang.String> networkInterfaceId()  
      com.pulumi.core.Output<java.lang.Integer> networkInterfacePort()  
      com.pulumi.core.Output<java.lang.Boolean> preserveExistingData()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> snapshotId()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.lang.String> targetArn()  
      com.pulumi.core.Output<java.lang.String> targetName()  
      com.pulumi.core.Output<java.lang.String> volumeAttachmentStatus()  
      com.pulumi.core.Output<java.lang.String> volumeId()  
      com.pulumi.core.Output<java.lang.Integer> volumeSizeInBytes()  
      com.pulumi.core.Output<java.lang.String> volumeStatus()  
      com.pulumi.core.Output<java.lang.String> volumeType()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • StoredIscsiVolume

        public StoredIscsiVolume​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • StoredIscsiVolume

        public StoredIscsiVolume​(java.lang.String name,
                         StoredIscsiVolumeArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • StoredIscsiVolume

        public StoredIscsiVolume​(java.lang.String name,
                         StoredIscsiVolumeArgs args,
                         @Nullable
                         com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        Volume ARN, e.g., `arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678`.

      • chapEnabled

        public com.pulumi.core.Output<java.lang.Boolean> chapEnabled()
        Returns:
        Whether mutual CHAP is enabled for the iSCSI target.

      • diskId

        public com.pulumi.core.Output<java.lang.String> diskId()
        Returns:
        The unique identifier for the gateway local disk that is configured as a stored volume.

      • gatewayArn

        public com.pulumi.core.Output<java.lang.String> gatewayArn()
        Returns:
        ARN of the gateway.

      • kmsEncrypted

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> kmsEncrypted()
        Returns:
        `true` to use Amazon S3 server side encryption with your own AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.

      • kmsKey

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> kmsKey()
        Returns:
        ARN of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when `kmsEncrypted` is `true`.

      • lunNumber

        public com.pulumi.core.Output<java.lang.Integer> lunNumber()
        Returns:
        Logical disk number.

      • networkInterfaceId

        public com.pulumi.core.Output<java.lang.String> networkInterfaceId()
        Returns:
        The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted.

      • networkInterfacePort

        public com.pulumi.core.Output<java.lang.Integer> networkInterfacePort()
        Returns:
        The port used to communicate with iSCSI targets.

      • preserveExistingData

        public com.pulumi.core.Output<java.lang.Boolean> preserveExistingData()
        Returns:
        Specify this field as `true` if you want to preserve the data on the local disk. Otherwise, specifying this field as false creates an empty volume.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • snapshotId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> snapshotId()
        Returns:
        The snapshot ID of the snapshot to restore as the new stored volumeE.g., `snap-1122aabb`.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value mapping of resource tags. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • targetArn

        public com.pulumi.core.Output<java.lang.String> targetArn()
        Returns:
        Target ARN, e.g., `arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/target/iqn.1997-05.com.amazon:TargetName`.

      • targetName

        public com.pulumi.core.Output<java.lang.String> targetName()
        Returns:
        The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN. The target name must be unique across all volumes of a gateway.

      • volumeAttachmentStatus

        public com.pulumi.core.Output<java.lang.String> volumeAttachmentStatus()
        Returns:
        A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway.

      • volumeId

        public com.pulumi.core.Output<java.lang.String> volumeId()
        Returns:
        Volume ID, e.g., `vol-12345678`.

      • volumeSizeInBytes

        public com.pulumi.core.Output<java.lang.Integer> volumeSizeInBytes()
        Returns:
        The size of the data stored on the volume in bytes.

      • volumeStatus

        public com.pulumi.core.Output<java.lang.String> volumeStatus()
        Returns:
        indicates the state of the storage volume.

      • volumeType

        public com.pulumi.core.Output<java.lang.String> volumeType()
        Returns:
        indicates the type of the volume.

      • get

        public static StoredIscsiVolume get​(java.lang.String name,
                                    com.pulumi.core.Output<java.lang.String> id,
                                    @Nullable
                                    StoredIscsiVolumeState state,
                                    @Nullable
                                    com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.