CfnVolumeProps

class aws_cdk.aws_storagegateway.CfnVolumeProps(*, gateway_arn, network_interface_id, target_name, volume_size_in_bytes, kms_encrypted=None, kms_key=None, snapshot_id=None, source_volume_arn=None, tags=None)

Bases: object

Properties for defining a CfnVolume.

Parameters:

gateway_arn (str) – The Amazon Resource Name (ARN) of the gateway on which to create the volume.
network_interface_id (str) – The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted.
target_name (str) – The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN.
volume_size_in_bytes (Union[int, float]) – The size of the volume in bytes.
kms_encrypted (Union[bool, IResolvable, None]) – 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.
kms_key (Optional[str]) – The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.
snapshot_id (Optional[str]) – The snapshot ID of the snapshot to restore as the new cached volume (e.g., snap-1122aabb).
source_volume_arn (Optional[str]) – The ARN of an existing volume from which to create the new volume.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A list of up to 50 tags to assign to the volume.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-storagegateway-volume.html

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_storagegateway as storagegateway

cfn_volume_props = storagegateway.CfnVolumeProps(
    gateway_arn="gatewayArn",
    network_interface_id="networkInterfaceId",
    target_name="targetName",
    volume_size_in_bytes=123,

    # the properties below are optional
    kms_encrypted=False,
    kms_key="kmsKey",
    snapshot_id="snapshotId",
    source_volume_arn="sourceVolumeArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)