CfnFileCachePropsMixin

class aws_cdk.cfn_property_mixins.aws_fsx.CfnFileCachePropsMixin(props, *, strategy=None)

Bases: Mixin

Resource Type definition for AWS::FSx::FileCache.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filecache.html
CloudformationResource:: AWS::FSx::FileCache
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_fsx as fsx
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_file_cache_props_mixin = fsx.CfnFileCachePropsMixin(fsx.CfnFileCacheMixinProps(
    copy_tags_to_data_repository_associations=False,
    data_repository_associations=[fsx.CfnFileCachePropsMixin.DataRepositoryAssociationProperty(
        data_repository_path="dataRepositoryPath",
        file_cache_path="fileCachePath"
    )],
    file_cache_type="fileCacheType",
    file_cache_type_version="fileCacheTypeVersion",
    kms_key_id="kmsKeyId",
    lustre_configuration=fsx.CfnFileCachePropsMixin.LustreConfigurationProperty(
        deployment_type="deploymentType",
        log_configuration=fsx.CfnFileCachePropsMixin.LogConfigurationProperty(
            destination="destination",
            level="level"
        ),
        metadata_configuration=fsx.CfnFileCachePropsMixin.MetadataConfigurationProperty(
            storage_capacity=123
        ),
        mount_name="mountName",
        per_unit_storage_throughput=123,
        weekly_maintenance_start_time="weeklyMaintenanceStartTime"
    ),
    security_group_ids=["securityGroupIds"],
    storage_capacity=123,
    subnet_ids=["subnetIds"],
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::FSx::FileCache.

Parameters:

props (Union[CfnFileCacheMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['copyTagsToDataRepositoryAssociations', 'dataRepositoryAssociations', 'fileCacheType', 'fileCacheTypeVersion', 'kmsKeyId', 'lustreConfiguration', 'securityGroupIds', 'storageCapacity', 'subnetIds', 'tags']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

DataRepositoryAssociationProperty

class CfnFileCachePropsMixin.DataRepositoryAssociationProperty(*, data_repository_path=None, file_cache_path=None)

Bases: object

Parameters:

data_repository_path (Optional[str])
file_cache_path (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filecache-datarepositoryassociation.html

ExampleMetadata:

fixture=_generated

Example:

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

data_repository_association_property = fsx.CfnFileCachePropsMixin.DataRepositoryAssociationProperty(
    data_repository_path="dataRepositoryPath",
    file_cache_path="fileCachePath"
)

Attributes

data_repository_path

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filecache-datarepositoryassociation.html#cfn-fsx-filecache-datarepositoryassociation-datarepositorypath

Type:: see

file_cache_path

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filecache-datarepositoryassociation.html#cfn-fsx-filecache-datarepositoryassociation-filecachepath

Type:: see

LogConfigurationProperty

class CfnFileCachePropsMixin.LogConfigurationProperty(*, destination=None, level=None)

Bases: object

Parameters:

destination (Optional[str])
level (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filecache-logconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

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

log_configuration_property = fsx.CfnFileCachePropsMixin.LogConfigurationProperty(
    destination="destination",
    level="level"
)

Attributes

destination

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filecache-logconfiguration.html#cfn-fsx-filecache-logconfiguration-destination

Type:: see

level

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filecache-logconfiguration.html#cfn-fsx-filecache-logconfiguration-level

Type:: see

LustreConfigurationProperty

class CfnFileCachePropsMixin.LustreConfigurationProperty(*, deployment_type=None, log_configuration=None, metadata_configuration=None, mount_name=None, per_unit_storage_throughput=None, weekly_maintenance_start_time=None)

Bases: object

Parameters:

deployment_type (Optional[str])
log_configuration (Union[IResolvable, LogConfigurationProperty, Dict[str, Any], None])
metadata_configuration (Union[IResolvable, MetadataConfigurationProperty, Dict[str, Any], None])
mount_name (Optional[str])
per_unit_storage_throughput (Union[int, float, None])
weekly_maintenance_start_time (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filecache-lustreconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

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

lustre_configuration_property = fsx.CfnFileCachePropsMixin.LustreConfigurationProperty(
    deployment_type="deploymentType",
    log_configuration=fsx.CfnFileCachePropsMixin.LogConfigurationProperty(
        destination="destination",
        level="level"
    ),
    metadata_configuration=fsx.CfnFileCachePropsMixin.MetadataConfigurationProperty(
        storage_capacity=123
    ),
    mount_name="mountName",
    per_unit_storage_throughput=123,
    weekly_maintenance_start_time="weeklyMaintenanceStartTime"
)

Attributes

deployment_type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filecache-lustreconfiguration.html#cfn-fsx-filecache-lustreconfiguration-deploymenttype

Type:: see

log_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filecache-lustreconfiguration.html#cfn-fsx-filecache-lustreconfiguration-logconfiguration

Type:: see

metadata_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filecache-lustreconfiguration.html#cfn-fsx-filecache-lustreconfiguration-metadataconfiguration

Type:: see

mount_name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filecache-lustreconfiguration.html#cfn-fsx-filecache-lustreconfiguration-mountname

Type:: see

per_unit_storage_throughput

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filecache-lustreconfiguration.html#cfn-fsx-filecache-lustreconfiguration-perunitstoragethroughput

Type:: see

weekly_maintenance_start_time

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filecache-lustreconfiguration.html#cfn-fsx-filecache-lustreconfiguration-weeklymaintenancestarttime

Type:: see

MetadataConfigurationProperty

class CfnFileCachePropsMixin.MetadataConfigurationProperty(*, storage_capacity=None)

Bases: object

Parameters:: storage_capacity (Union[int, float, None])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filecache-metadataconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

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

metadata_configuration_property = fsx.CfnFileCachePropsMixin.MetadataConfigurationProperty(
    storage_capacity=123
)

Attributes

storage_capacity

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filecache-metadataconfiguration.html#cfn-fsx-filecache-metadataconfiguration-storagecapacity

Type:: see