CfnLocationSMBPropsMixin

class aws_cdk.mixins_preview.aws_datasync.mixins.CfnLocationSMBPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::DataSync::LocationSMB resource specifies a Server Message Block (SMB) location that AWS DataSync can use as a transfer source or destination.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html
CloudformationResource:: AWS::DataSync::LocationSMB
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_datasync import mixins as datasync_mixins

cfn_location_sMBProps_mixin = datasync_mixins.CfnLocationSMBPropsMixin(datasync_mixins.CfnLocationSMBMixinProps(
    agent_arns=["agentArns"],
    authentication_type="authenticationType",
    cmk_secret_config=datasync_mixins.CfnLocationSMBPropsMixin.CmkSecretConfigProperty(
        kms_key_arn="kmsKeyArn",
        secret_arn="secretArn"
    ),
    custom_secret_config=datasync_mixins.CfnLocationSMBPropsMixin.CustomSecretConfigProperty(
        secret_access_role_arn="secretAccessRoleArn",
        secret_arn="secretArn"
    ),
    dns_ip_addresses=["dnsIpAddresses"],
    domain="domain",
    kerberos_keytab="kerberosKeytab",
    kerberos_krb5_conf="kerberosKrb5Conf",
    kerberos_principal="kerberosPrincipal",
    mount_options=datasync_mixins.CfnLocationSMBPropsMixin.MountOptionsProperty(
        version="version"
    ),
    password="password",
    server_hostname="serverHostname",
    subdirectory="subdirectory",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    user="user"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnLocationSMBMixinProps, 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 = ['agentArns', 'authenticationType', 'cmkSecretConfig', 'customSecretConfig', 'dnsIpAddresses', 'domain', 'kerberosKeytab', 'kerberosKrb5Conf', 'kerberosPrincipal', 'mountOptions', 'password', 'serverHostname', 'subdirectory', 'tags', 'user']

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

CmkSecretConfigProperty

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

Bases: object

Specifies configuration information for a DataSync-managed secret, such as an authentication token or secret key that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key .

You can use either CmkSecretConfig or CustomSecretConfig to provide credentials for a CreateLocation request. Do not provide both parameters for the same request.

Parameters:

kms_key_arn (Optional[str]) – Specifies the ARN for the customer-managed AWS KMS key that DataSync uses to encrypt the DataSync-managed secret stored for SecretArn . DataSync provides this key to AWS Secrets Manager .
secret_arn (Optional[str]) – Specifies the ARN for the DataSync-managed AWS Secrets Manager secret that that is used to access a specific storage location. This property is generated by DataSync and is read-only. DataSync encrypts this secret with the KMS key that you specify for KmsKeyArn .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationsmb-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.mixins_preview.aws_datasync import mixins as datasync_mixins

cmk_secret_config_property = datasync_mixins.CfnLocationSMBPropsMixin.CmkSecretConfigProperty(
    kms_key_arn="kmsKeyArn",
    secret_arn="secretArn"
)

Attributes

kms_key_arn

Specifies the ARN for the customer-managed AWS KMS key that DataSync uses to encrypt the DataSync-managed secret stored for SecretArn .

DataSync provides this key to AWS Secrets Manager .

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

secret_arn

Specifies the ARN for the DataSync-managed AWS Secrets Manager secret that that is used to access a specific storage location.

This property is generated by DataSync and is read-only. DataSync encrypts this secret with the KMS key that you specify for KmsKeyArn .

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

CustomSecretConfigProperty

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

Bases: object

Specifies configuration information for a customer-managed Secrets Manager secret where a storage location authentication token or secret key is stored in plain text.

This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. .. epigraph:

You can use either ``CmkSecretConfig`` or ``CustomSecretConfig`` to provide credentials for a ``CreateLocation`` request. Do not provide both parameters for the same request.

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 an AWS Secrets Manager secret.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationsmb-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.mixins_preview.aws_datasync import mixins as datasync_mixins

custom_secret_config_property = datasync_mixins.CfnLocationSMBPropsMixin.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-locationsmb-customsecretconfig.html#cfn-datasync-locationsmb-customsecretconfig-secretaccessrolearn

secret_arn

Specifies the ARN for an AWS Secrets Manager secret.

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

ManagedSecretConfigProperty

class CfnLocationSMBPropsMixin.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-locationsmb-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.mixins_preview.aws_datasync import mixins as datasync_mixins

managed_secret_config_property = datasync_mixins.CfnLocationSMBPropsMixin.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-locationsmb-managedsecretconfig.html#cfn-datasync-locationsmb-managedsecretconfig-secretarn

MountOptionsProperty

class CfnLocationSMBPropsMixin.MountOptionsProperty(*, version=None)

Bases: object

Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.

Parameters:: version (Optional[str]) – By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically. These are the following options for configuring the SMB version: - AUTOMATIC (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1. This is the recommended option. If you instead choose a specific version that your file server doesn’t support, you may get an Operation Not Supported error. - SMB3 : Restricts the protocol negotiation to only SMB version 3.0.2. - SMB2 : Restricts the protocol negotiation to only SMB version 2.1. - SMB2_0 : Restricts the protocol negotiation to only SMB version 2.0. - SMB1 : Restricts the protocol negotiation to only SMB version 1.0. .. epigraph:: The SMB1 option isn’t available when creating an Amazon FSx for NetApp ONTAP location .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationsmb-mountoptions.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_datasync import mixins as datasync_mixins

mount_options_property = datasync_mixins.CfnLocationSMBPropsMixin.MountOptionsProperty(
    version="version"
)

Attributes

version

By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server.

You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically.

These are the following options for configuring the SMB version:

AUTOMATIC (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1.

This is the recommended option. If you instead choose a specific version that your file server doesn’t support, you may get an Operation Not Supported error.

SMB3 : Restricts the protocol negotiation to only SMB version 3.0.2.
SMB2 : Restricts the protocol negotiation to only SMB version 2.1.
SMB2_0 : Restricts the protocol negotiation to only SMB version 2.0.
SMB1 : Restricts the protocol negotiation to only SMB version 1.0.

The SMB1 option isn’t available when creating an Amazon FSx for NetApp ONTAP location .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationsmb-mountoptions.html#cfn-datasync-locationsmb-mountoptions-version