CfnS3AccessPointAttachmentPropsMixin

class aws_cdk.mixins_preview.aws_fsx.mixins.CfnS3AccessPointAttachmentPropsMixin(props, *, strategy=None)

Bases: Mixin

An S3 access point attached to an Amazon FSx volume.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-s3accesspointattachment.html
CloudformationResource:: AWS::FSx::S3AccessPointAttachment
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_fsx import mixins as fsx_mixins

# policy: Any

cfn_s3_access_point_attachment_props_mixin = fsx_mixins.CfnS3AccessPointAttachmentPropsMixin(fsx_mixins.CfnS3AccessPointAttachmentMixinProps(
    name="name",
    open_zfs_configuration=fsx_mixins.CfnS3AccessPointAttachmentPropsMixin.S3AccessPointOpenZFSConfigurationProperty(
        file_system_identity=fsx_mixins.CfnS3AccessPointAttachmentPropsMixin.OpenZFSFileSystemIdentityProperty(
            posix_user=fsx_mixins.CfnS3AccessPointAttachmentPropsMixin.OpenZFSPosixFileSystemUserProperty(
                gid=123,
                secondary_gids=[fsx_mixins.CfnS3AccessPointAttachmentPropsMixin.FileSystemGIDProperty(
                    gid=123
                )],
                uid=123
            ),
            type="type"
        ),
        volume_id="volumeId"
    ),
    s3_access_point=fsx_mixins.CfnS3AccessPointAttachmentPropsMixin.S3AccessPointProperty(
        alias="alias",
        policy=policy,
        resource_arn="resourceArn",
        vpc_configuration=fsx_mixins.CfnS3AccessPointAttachmentPropsMixin.S3AccessPointVpcConfigurationProperty(
            vpc_id="vpcId"
        )
    ),
    type="type"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

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

Methods

apply_to(construct)

Apply the mixin properties to the construct.

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

supports(construct)

Check if this mixin supports the given construct.

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

Attributes

CFN_PROPERTY_KEYS = ['name', 'openZfsConfiguration', 's3AccessPoint', 'type']

Static Methods

classmethod is_mixin(x)

(experimental) 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.
Stability:: experimental

FileSystemGIDProperty

class CfnS3AccessPointAttachmentPropsMixin.FileSystemGIDProperty(*, gid=None)

Bases: object

The GID of the file system user.

Parameters:: gid (Union[int, float, None]) – The GID of the file system user.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-filesystemgid.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.mixins_preview.aws_fsx import mixins as fsx_mixins

file_system_gIDProperty = fsx_mixins.CfnS3AccessPointAttachmentPropsMixin.FileSystemGIDProperty(
    gid=123
)

Attributes

gid

The GID of the file system user.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-filesystemgid.html#cfn-fsx-s3accesspointattachment-filesystemgid-gid

OpenZFSFileSystemIdentityProperty

class CfnS3AccessPointAttachmentPropsMixin.OpenZFSFileSystemIdentityProperty(*, posix_user=None, type=None)

Bases: object

Specifies the file system user identity that will be used for authorizing all file access requests that are made using the S3 access point.

Parameters:

posix_user (Union[IResolvable, OpenZFSPosixFileSystemUserProperty, Dict[str, Any], None]) – Specifies the UID and GIDs of the file system POSIX user.
type (Optional[str]) – Specifies the FSx for OpenZFS user identity type, accepts only POSIX .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-openzfsfilesystemidentity.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.mixins_preview.aws_fsx import mixins as fsx_mixins

open_zFSFile_system_identity_property = fsx_mixins.CfnS3AccessPointAttachmentPropsMixin.OpenZFSFileSystemIdentityProperty(
    posix_user=fsx_mixins.CfnS3AccessPointAttachmentPropsMixin.OpenZFSPosixFileSystemUserProperty(
        gid=123,
        secondary_gids=[fsx_mixins.CfnS3AccessPointAttachmentPropsMixin.FileSystemGIDProperty(
            gid=123
        )],
        uid=123
    ),
    type="type"
)

Attributes

posix_user

Specifies the UID and GIDs of the file system POSIX user.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-openzfsfilesystemidentity.html#cfn-fsx-s3accesspointattachment-openzfsfilesystemidentity-posixuser

type

Specifies the FSx for OpenZFS user identity type, accepts only POSIX .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-openzfsfilesystemidentity.html#cfn-fsx-s3accesspointattachment-openzfsfilesystemidentity-type

OpenZFSPosixFileSystemUserProperty

class CfnS3AccessPointAttachmentPropsMixin.OpenZFSPosixFileSystemUserProperty(*, gid=None, secondary_gids=None, uid=None)

Bases: object

The FSx for OpenZFS file system user that is used for authorizing all file access requests that are made using the S3 access point.

Parameters:

gid (Union[int, float, None]) – The GID of the file system user.
secondary_gids (Union[IResolvable, Sequence[Union[IResolvable, FileSystemGIDProperty, Dict[str, Any]]], None]) – The list of secondary GIDs for the file system user.
uid (Union[int, float, None]) – The UID of the file system user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-openzfsposixfilesystemuser.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.mixins_preview.aws_fsx import mixins as fsx_mixins

open_zFSPosix_file_system_user_property = fsx_mixins.CfnS3AccessPointAttachmentPropsMixin.OpenZFSPosixFileSystemUserProperty(
    gid=123,
    secondary_gids=[fsx_mixins.CfnS3AccessPointAttachmentPropsMixin.FileSystemGIDProperty(
        gid=123
    )],
    uid=123
)

Attributes

gid

The GID of the file system user.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-openzfsposixfilesystemuser.html#cfn-fsx-s3accesspointattachment-openzfsposixfilesystemuser-gid

secondary_gids

The list of secondary GIDs for the file system user.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-openzfsposixfilesystemuser.html#cfn-fsx-s3accesspointattachment-openzfsposixfilesystemuser-secondarygids

uid

The UID of the file system user.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-openzfsposixfilesystemuser.html#cfn-fsx-s3accesspointattachment-openzfsposixfilesystemuser-uid

S3AccessPointOpenZFSConfigurationProperty

class CfnS3AccessPointAttachmentPropsMixin.S3AccessPointOpenZFSConfigurationProperty(*, file_system_identity=None, volume_id=None)

Bases: object

Describes the FSx for OpenZFS attachment configuration of an S3 access point attachment.

Parameters:

file_system_identity (Union[IResolvable, OpenZFSFileSystemIdentityProperty, Dict[str, Any], None]) – The file system identity used to authorize file access requests made using the S3 access point.
volume_id (Optional[str]) – The ID of the FSx for OpenZFS volume that the S3 access point is attached to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-s3accesspointopenzfsconfiguration.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.mixins_preview.aws_fsx import mixins as fsx_mixins

s3_access_point_open_zFSConfiguration_property = fsx_mixins.CfnS3AccessPointAttachmentPropsMixin.S3AccessPointOpenZFSConfigurationProperty(
    file_system_identity=fsx_mixins.CfnS3AccessPointAttachmentPropsMixin.OpenZFSFileSystemIdentityProperty(
        posix_user=fsx_mixins.CfnS3AccessPointAttachmentPropsMixin.OpenZFSPosixFileSystemUserProperty(
            gid=123,
            secondary_gids=[fsx_mixins.CfnS3AccessPointAttachmentPropsMixin.FileSystemGIDProperty(
                gid=123
            )],
            uid=123
        ),
        type="type"
    ),
    volume_id="volumeId"
)

Attributes

file_system_identity

The file system identity used to authorize file access requests made using the S3 access point.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-s3accesspointopenzfsconfiguration.html#cfn-fsx-s3accesspointattachment-s3accesspointopenzfsconfiguration-filesystemidentity

volume_id

The ID of the FSx for OpenZFS volume that the S3 access point is attached to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-s3accesspointopenzfsconfiguration.html#cfn-fsx-s3accesspointattachment-s3accesspointopenzfsconfiguration-volumeid

S3AccessPointProperty

class CfnS3AccessPointAttachmentPropsMixin.S3AccessPointProperty(*, alias=None, policy=None, resource_arn=None, vpc_configuration=None)

Bases: object

Describes the S3 access point configuration of the S3 access point attachment.

Parameters:

alias (Optional[str]) – The S3 access point’s alias.
policy (Any) – The S3 access point’s policy.
resource_arn (Optional[str]) – The S3 access point’s ARN.
vpc_configuration (Union[IResolvable, S3AccessPointVpcConfigurationProperty, Dict[str, Any], None]) – The S3 access point’s virtual private cloud (VPC) configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-s3accesspoint.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.mixins_preview.aws_fsx import mixins as fsx_mixins

# policy: Any

s3_access_point_property = fsx_mixins.CfnS3AccessPointAttachmentPropsMixin.S3AccessPointProperty(
    alias="alias",
    policy=policy,
    resource_arn="resourceArn",
    vpc_configuration=fsx_mixins.CfnS3AccessPointAttachmentPropsMixin.S3AccessPointVpcConfigurationProperty(
        vpc_id="vpcId"
    )
)

Attributes

alias

The S3 access point’s alias.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-s3accesspoint.html#cfn-fsx-s3accesspointattachment-s3accesspoint-alias

policy

The S3 access point’s policy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-s3accesspoint.html#cfn-fsx-s3accesspointattachment-s3accesspoint-policy

resource_arn

The S3 access point’s ARN.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-s3accesspoint.html#cfn-fsx-s3accesspointattachment-s3accesspoint-resourcearn

vpc_configuration

The S3 access point’s virtual private cloud (VPC) configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-s3accesspoint.html#cfn-fsx-s3accesspointattachment-s3accesspoint-vpcconfiguration

S3AccessPointVpcConfigurationProperty

class CfnS3AccessPointAttachmentPropsMixin.S3AccessPointVpcConfigurationProperty(*, vpc_id=None)

Bases: object

If included, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).

Parameters:: vpc_id (Optional[str]) – Specifies the virtual private cloud (VPC) for the S3 access point VPC configuration, if one exists.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-s3accesspointvpcconfiguration.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.mixins_preview.aws_fsx import mixins as fsx_mixins

s3_access_point_vpc_configuration_property = fsx_mixins.CfnS3AccessPointAttachmentPropsMixin.S3AccessPointVpcConfigurationProperty(
    vpc_id="vpcId"
)

Attributes

vpc_id

Specifies the virtual private cloud (VPC) for the S3 access point VPC configuration, if one exists.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-s3accesspointvpcconfiguration.html#cfn-fsx-s3accesspointattachment-s3accesspointvpcconfiguration-vpcid