CfnLocationFSxWindowsPropsMixin

class aws_cdk.cfn_property_mixins.aws_datasync.CfnLocationFSxWindowsPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::DataSync::LocationFSxWindows resource specifies an endpoint for an Amazon FSx for Windows Server file system.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html
CloudformationResource:: AWS::DataSync::LocationFSxWindows
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_datasync as datasync
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_location_fSx_windows_props_mixin = datasync.CfnLocationFSxWindowsPropsMixin(datasync.CfnLocationFSxWindowsMixinProps(
    cmk_secret_config=datasync.CfnLocationFSxWindowsPropsMixin.CmkSecretConfigProperty(
        kms_key_arn="kmsKeyArn",
        secret_arn="secretArn"
    ),
    custom_secret_config=datasync.CfnLocationFSxWindowsPropsMixin.CustomSecretConfigProperty(
        secret_access_role_arn="secretAccessRoleArn",
        secret_arn="secretArn"
    ),
    domain="domain",
    fsx_filesystem_arn="fsxFilesystemArn",
    password="password",
    security_group_arns=["securityGroupArns"],
    subdirectory="subdirectory",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )],
    user="user"
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::DataSync::LocationFSxWindows.

Parameters:

props (Union[CfnLocationFSxWindowsMixinProps, 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 = ['cmkSecretConfig', 'customSecretConfig', 'domain', 'fsxFilesystemArn', 'password', 'securityGroupArns', 'subdirectory', 'tags', 'user']

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.

CmkSecretConfigProperty

class CfnLocationFSxWindowsPropsMixin.CmkSecretConfigProperty(*, kms_key_arn=None, secret_arn=None)

Bases: object

Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key.

Parameters:

kms_key_arn (Optional[str]) – Specifies the ARN for the customer-managed AWS KMS key used to encrypt the secret specified for SecretArn. DataSync provides this key to AWS Secrets Manager.
secret_arn (Optional[str]) – Specifies the ARN for an AWS Secrets Manager secret, managed by DataSync.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxwindows-cmksecretconfig.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_datasync as datasync

cmk_secret_config_property = datasync.CfnLocationFSxWindowsPropsMixin.CmkSecretConfigProperty(
    kms_key_arn="kmsKeyArn",
    secret_arn="secretArn"
)

Attributes

kms_key_arn

Specifies the ARN for the customer-managed AWS KMS key used to encrypt the secret specified for SecretArn.

DataSync provides this key to AWS Secrets Manager.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxwindows-cmksecretconfig.html#cfn-datasync-locationfsxwindows-cmksecretconfig-kmskeyarn

secret_arn

Specifies the ARN for an AWS Secrets Manager secret, managed by DataSync.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxwindows-cmksecretconfig.html#cfn-datasync-locationfsxwindows-cmksecretconfig-secretarn

CustomSecretConfigProperty

class CfnLocationFSxWindowsPropsMixin.CustomSecretConfigProperty(*, secret_access_role_arn=None, secret_arn=None)

Bases: object

Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret.

Parameters:

secret_access_role_arn (Optional[str]) – Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.
secret_arn (Optional[str]) – Specifies the ARN for a customer created AWS Secrets Manager secret.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxwindows-customsecretconfig.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_datasync as datasync

custom_secret_config_property = datasync.CfnLocationFSxWindowsPropsMixin.CustomSecretConfigProperty(
    secret_access_role_arn="secretAccessRoleArn",
    secret_arn="secretArn"
)

Attributes

secret_access_role_arn

Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxwindows-customsecretconfig.html#cfn-datasync-locationfsxwindows-customsecretconfig-secretaccessrolearn

secret_arn

Specifies the ARN for a customer created AWS Secrets Manager secret.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxwindows-customsecretconfig.html#cfn-datasync-locationfsxwindows-customsecretconfig-secretarn

ManagedSecretConfigProperty

class CfnLocationFSxWindowsPropsMixin.ManagedSecretConfigProperty(*, secret_arn=None)

Bases: object

Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location.

DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.

Parameters:: secret_arn (Optional[str]) – Specifies the ARN for an AWS Secrets Manager secret.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxwindows-managedsecretconfig.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_datasync as datasync

managed_secret_config_property = datasync.CfnLocationFSxWindowsPropsMixin.ManagedSecretConfigProperty(
    secret_arn="secretArn"
)

Attributes

secret_arn

Specifies the ARN for an AWS Secrets Manager secret.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxwindows-managedsecretconfig.html#cfn-datasync-locationfsxwindows-managedsecretconfig-secretarn