CfnLocationAzureBlobPropsMixin

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

Bases: Mixin

Creates a transfer location for a Microsoft Azure Blob Storage container.

AWS DataSync can use this location as a transfer source or destination. You can make transfers with or without a DataSync agent that connects to your container.

Before you begin, make sure you know how DataSync accesses Azure Blob Storage and works with access tiers and blob types .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html
CloudformationResource:: AWS::DataSync::LocationAzureBlob
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_azure_blob_props_mixin = datasync_mixins.CfnLocationAzureBlobPropsMixin(datasync_mixins.CfnLocationAzureBlobMixinProps(
    agent_arns=["agentArns"],
    azure_access_tier="azureAccessTier",
    azure_blob_authentication_type="azureBlobAuthenticationType",
    azure_blob_container_url="azureBlobContainerUrl",
    azure_blob_sas_configuration=datasync_mixins.CfnLocationAzureBlobPropsMixin.AzureBlobSasConfigurationProperty(
        azure_blob_sas_token="azureBlobSasToken"
    ),
    azure_blob_type="azureBlobType",
    cmk_secret_config=datasync_mixins.CfnLocationAzureBlobPropsMixin.CmkSecretConfigProperty(
        kms_key_arn="kmsKeyArn",
        secret_arn="secretArn"
    ),
    custom_secret_config=datasync_mixins.CfnLocationAzureBlobPropsMixin.CustomSecretConfigProperty(
        secret_access_role_arn="secretAccessRoleArn",
        secret_arn="secretArn"
    ),
    subdirectory="subdirectory",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnLocationAzureBlobMixinProps, 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', 'azureAccessTier', 'azureBlobAuthenticationType', 'azureBlobContainerUrl', 'azureBlobSasConfiguration', 'azureBlobType', 'cmkSecretConfig', 'customSecretConfig', 'subdirectory', 'tags']

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

AzureBlobSasConfigurationProperty

class CfnLocationAzureBlobPropsMixin.AzureBlobSasConfigurationProperty(*, azure_blob_sas_token=None)

Bases: object

The shared access signature (SAS) configuration that allows AWS DataSync to access your Microsoft Azure Blob Storage.

For more information, see SAS tokens for accessing your Azure Blob Storage.

Parameters:: azure_blob_sas_token (Optional[str]) – Specifies a SAS token that provides permissions to access your Azure Blob Storage. The token is part of the SAS URI string that comes after the storage resource URI and a question mark. A token looks something like this: sp=r&st=2023-12-20T14:54:52Z&se=2023-12-20T22:54:52Z&spr=https&sv=2021-06-08&sr=c&sig=aBBKDWQvyuVcTPH9EBp%2FXTI9E%2F%2Fmq171%2BZU178wcwqU%3D
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationazureblob-azureblobsasconfiguration.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

azure_blob_sas_configuration_property = datasync_mixins.CfnLocationAzureBlobPropsMixin.AzureBlobSasConfigurationProperty(
    azure_blob_sas_token="azureBlobSasToken"
)

Attributes

azure_blob_sas_token

Specifies a SAS token that provides permissions to access your Azure Blob Storage.

The token is part of the SAS URI string that comes after the storage resource URI and a question mark. A token looks something like this:

sp=r&st=2023-12-20T14:54:52Z&se=2023-12-20T22:54:52Z&spr=https&sv=2021-06-08&sr=c&sig=aBBKDWQvyuVcTPH9EBp%2FXTI9E%2F%2Fmq171%2BZU178wcwqU%3D

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationazureblob-azureblobsasconfiguration.html#cfn-datasync-locationazureblob-azureblobsasconfiguration-azureblobsastoken

CmkSecretConfigProperty

class CfnLocationAzureBlobPropsMixin.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-locationazureblob-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.CfnLocationAzureBlobPropsMixin.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-locationazureblob-cmksecretconfig.html#cfn-datasync-locationazureblob-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-locationazureblob-cmksecretconfig.html#cfn-datasync-locationazureblob-cmksecretconfig-secretarn

CustomSecretConfigProperty

class CfnLocationAzureBlobPropsMixin.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-locationazureblob-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.CfnLocationAzureBlobPropsMixin.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-locationazureblob-customsecretconfig.html#cfn-datasync-locationazureblob-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-locationazureblob-customsecretconfig.html#cfn-datasync-locationazureblob-customsecretconfig-secretarn

ManagedSecretConfigProperty

class CfnLocationAzureBlobPropsMixin.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-locationazureblob-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.CfnLocationAzureBlobPropsMixin.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-locationazureblob-managedsecretconfig.html#cfn-datasync-locationazureblob-managedsecretconfig-secretarn