CfnLocationAzureBlobProps

class aws_cdk.aws_datasync.CfnLocationAzureBlobProps(*, azure_blob_authentication_type, agent_arns=None, azure_access_tier=None, azure_blob_container_url=None, azure_blob_sas_configuration=None, azure_blob_type=None, cmk_secret_config=None, custom_secret_config=None, subdirectory=None, tags=None)

Bases: object

Properties for defining a CfnLocationAzureBlob.

Parameters:

  • azure_blob_authentication_type (str) – Specifies the authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS). Default: - “SAS”

  • agent_arns (Optional[Sequence[str]]) – (Optional) Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter. You can specify more than one agent. For more information, see Using multiple agents for your transfer . .. epigraph:: Make sure you configure this parameter correctly when you first create your storage location. You cannot add or remove agents from a storage location after you create it.

  • azure_access_tier (Optional[str]) – Specifies the access tier that you want your objects or files transferred into. This only applies when using the location as a transfer destination. For more information, see Access tiers . Default: - “HOT”

  • azure_blob_container_url (Optional[str]) – Specifies the URL of the Azure Blob Storage container involved in your transfer.

  • azure_blob_sas_configuration (Union[IResolvable, AzureBlobSasConfigurationProperty, Dict[str, Any], None]) – Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage. .. epigraph:: If you provide an authentication token using SasConfiguration , but do not provide secret configuration details using CmkSecretConfig or CustomSecretConfig , then DataSync stores the token using your AWS account’s secrets manager secret.

  • azure_blob_type (Optional[str]) – Specifies the type of blob that you want your objects or files to be when transferring them into Azure Blob Storage. Currently, DataSync only supports moving data into Azure Blob Storage as block blobs. For more information on blob types, see the Azure Blob Storage documentation . Default: - “BLOCK”

  • cmk_secret_config (Union[IResolvable, CmkSecretConfigProperty, Dict[str, Any], None]) – 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 . .. epigraph:: You can use either CmkSecretConfig or CustomSecretConfig to provide credentials for a CreateLocation request. Do not provide both parameters for the same request.

  • custom_secret_config (Union[IResolvable, CustomSecretConfigProperty, Dict[str, Any], None]) – 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.

  • subdirectory (Optional[str]) – Specifies path segments if you want to limit your transfer to a virtual directory in your container (for example, /my/images ).

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Specifies labels that help you categorize, filter, and search for your AWS resources. We recommend creating at least a name tag for your transfer location.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.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 import aws_datasync as datasync

cfn_location_azure_blob_props = datasync.CfnLocationAzureBlobProps(
    azure_blob_authentication_type="azureBlobAuthenticationType",

    # the properties below are optional
    agent_arns=["agentArns"],
    azure_access_tier="azureAccessTier",
    azure_blob_container_url="azureBlobContainerUrl",
    azure_blob_sas_configuration=datasync.CfnLocationAzureBlob.AzureBlobSasConfigurationProperty(
        azure_blob_sas_token="azureBlobSasToken"
    ),
    azure_blob_type="azureBlobType",
    cmk_secret_config=datasync.CfnLocationAzureBlob.CmkSecretConfigProperty(
        kms_key_arn="kmsKeyArn",
        secret_arn="secretArn"
    ),
    custom_secret_config=datasync.CfnLocationAzureBlob.CustomSecretConfigProperty(
        secret_access_role_arn="secretAccessRoleArn",
        secret_arn="secretArn"
    ),
    subdirectory="subdirectory",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

agent_arns

(Optional) Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container.

If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter.

You can specify more than one agent. For more information, see Using multiple agents for your transfer . .. epigraph:

Make sure you configure this parameter correctly when you first create your storage location. You cannot add or remove agents from a storage location after you create it.
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-agentarns

azure_access_tier

Specifies the access tier that you want your objects or files transferred into.

This only applies when using the location as a transfer destination. For more information, see Access tiers .

Default:

  • “HOT”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-azureaccesstier

azure_blob_authentication_type

Specifies the authentication method DataSync uses to access your Azure Blob Storage.

DataSync can access blob storage using a shared access signature (SAS).

Default:

  • “SAS”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-azureblobauthenticationtype

azure_blob_container_url

Specifies the URL of the Azure Blob Storage container involved in your transfer.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-azureblobcontainerurl

azure_blob_sas_configuration

Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage.

If you provide an authentication token using SasConfiguration , but do not provide secret configuration details using CmkSecretConfig or CustomSecretConfig , then DataSync stores the token using your AWS account’s secrets manager secret.

See:

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

azure_blob_type

Specifies the type of blob that you want your objects or files to be when transferring them into Azure Blob Storage.

Currently, DataSync only supports moving data into Azure Blob Storage as block blobs. For more information on blob types, see the Azure Blob Storage documentation .

Default:

  • “BLOCK”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-azureblobtype

cmk_secret_config

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-cmksecretconfig

custom_secret_config

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.
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-customsecretconfig

subdirectory

Specifies path segments if you want to limit your transfer to a virtual directory in your container (for example, /my/images ).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-subdirectory

tags

Specifies labels that help you categorize, filter, and search for your AWS resources.

We recommend creating at least a name tag for your transfer location.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-tags