:doc:`StorageGateway <../../storagegateway>` / Client / create_cached_iscsi_volume

**************************
create_cached_iscsi_volume
**************************



.. py:method:: StorageGateway.Client.create_cached_iscsi_volume(**kwargs)

  

  Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway type.

   

  .. note::

    

    Cache storage must be allocated to the gateway before you can create a cached volume. Use the  AddCache operation to add cache storage to a gateway.

    

   

  In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, the gateway creates the volume and returns information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

   

  Optionally, you can provide the ARN for an existing volume as the ``SourceVolumeARN`` for this cached volume, which creates an exact copy of the existing volume’s latest recovery point. The ``VolumeSizeInBytes`` value must be equal to or larger than the size of the copied volume, in bytes.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CreateCachediSCSIVolume>`_  


  **Request Syntax**
  ::

    response = client.create_cached_iscsi_volume(
        GatewayARN='string',
        VolumeSizeInBytes=123,
        SnapshotId='string',
        TargetName='string',
        SourceVolumeARN='string',
        NetworkInterfaceId='string',
        ClientToken='string',
        KMSEncrypted=True|False,
        KMSKey='string',
        Tags=[
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    )
    
  :type GatewayARN: string
  :param GatewayARN: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the gateway. Use the  ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    

  
  :type VolumeSizeInBytes: integer
  :param VolumeSizeInBytes: **[REQUIRED]** 

    The size of the volume in bytes.

    

  
  :type SnapshotId: string
  :param SnapshotId: 

    The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new cached volume. Specify this field if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this field. To list snapshots for your account use `DescribeSnapshots <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html>`__ in the *Amazon Elastic Compute Cloud API Reference*.

    

  
  :type TargetName: string
  :param TargetName: **[REQUIRED]** 

    The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying ``TargetName`` as *myvolume* results in the target ARN of ``arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume``. The target name must be unique across all volumes on a gateway.

     

    If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

    

  
  :type SourceVolumeARN: string
  :param SourceVolumeARN: 

    The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The ``VolumeSizeInBytes`` value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

    

  
  :type NetworkInterfaceId: string
  :param NetworkInterfaceId: **[REQUIRED]** 

    The network interface of the gateway on which to expose the iSCSI target. Accepts IPv4 and IPv6 addresses. Use  DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

     

    Valid Values: A valid IP address.

    

  
  :type ClientToken: string
  :param ClientToken: **[REQUIRED]** 

    A unique identifier that you use to retry a request. If you retry a request, use the same ``ClientToken`` you specified in the initial request.

    

  
  :type KMSEncrypted: boolean
  :param KMSEncrypted: 

    Set to ``true`` to use Amazon S3 server-side encryption with your own KMS key, or ``false`` to use a key managed by Amazon S3. Optional.

     

    Valid Values: ``true`` | ``false``

    

  
  :type KMSKey: string
  :param KMSKey: 

    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when ``KMSEncrypted`` is ``true``. Optional.

    

  
  :type Tags: list
  :param Tags: 

    A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value pair.

     

    .. note::

      

      Valid characters for key and value are letters, spaces, and numbers that you can represent in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.

      

    

  
    - *(dict) --* 

      A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.

      

    
      - **Key** *(string) --* **[REQUIRED]** 

        Tag key. The key can't start with aws:.

        

      
      - **Value** *(string) --* **[REQUIRED]** 

        Value of the tag key.

        

      
    

  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'VolumeARN': 'string',
          'TargetARN': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **VolumeARN** *(string) --* 

        The Amazon Resource Name (ARN) of the configured volume.

        
      

      - **TargetARN** *(string) --* 

        The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that initiators can use to connect to the target.

        
  
  **Exceptions**
  
  *   :py:class:`StorageGateway.Client.exceptions.InvalidGatewayRequestException`

  
  *   :py:class:`StorageGateway.Client.exceptions.InternalServerError`

  

  **Examples**

  Creates a cached volume on a specified cached gateway.
  ::

    response = client.create_cached_iscsi_volume(
        ClientToken='cachedvol112233',
        GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
        NetworkInterfaceId='10.1.1.1',
        SnapshotId='snap-f47b7b94',
        TargetName='my-volume',
        VolumeSizeInBytes=536870912000,
    )
    
    print(response)

  
  Expected Output:
  ::

    {
        'TargetARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
        'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
        'ResponseMetadata': {
            '...': '...',
        },
    }

  