class CfnVolumePropsMixin (mixin)

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.StorageGateway.CfnVolumePropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsstoragegateway#CfnVolumePropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.storagegateway.CfnVolumePropsMixin
Python	aws_cdk.cfn_property_mixins.aws_storagegateway.CfnVolumePropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_storagegateway » CfnVolumePropsMixin

Implements IMixin

Extends Mixin

Creates a cached iSCSI volume on a Storage Gateway.

A cached volume stores data in Amazon S3 and retains a copy of frequently accessed data subsets locally.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_storagegateway as storagegateway } from '@aws-cdk/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const mergeStrategy: cdk.IMergeStrategy;
const cfnVolumePropsMixin = new storagegateway.CfnVolumePropsMixin({
  gatewayArn: 'gatewayArn',
  kmsEncrypted: false,
  kmsKey: 'kmsKey',
  networkInterfaceId: 'networkInterfaceId',
  snapshotId: 'snapshotId',
  sourceVolumeArn: 'sourceVolumeArn',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  targetName: 'targetName',
  volumeSizeInBytes: 123,
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnVolumePropsMixin(props: CfnVolumeMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnVolumeMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::StorageGateway::Volume.

Properties

Name	Type	Description
props	CfnVolumeMixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnVolumeMixinProps

---

strategy

Type: IMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): void

Parameters

• construct IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.