AWS::DataSync::LocationAzureBlob

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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::DataSync::LocationAzureBlob",
  "Properties" : {
      "AgentArns" : [ String, ... ],
      "AzureAccessTier" : String,
      "AzureBlobAuthenticationType" : String,
      "AzureBlobContainerUrl" : String,
      "AzureBlobSasConfiguration" : AzureBlobSasConfiguration,
      "AzureBlobType" : String,
      "CmkSecretConfig" : CmkSecretConfig,
      "CustomSecretConfig" : CustomSecretConfig,
      "Subdirectory" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::DataSync::LocationAzureBlob
Properties:
  AgentArns: 
    - String
  AzureAccessTier: String
  AzureBlobAuthenticationType: String
  AzureBlobContainerUrl: String
  AzureBlobSasConfiguration: 
    AzureBlobSasConfiguration
  AzureBlobType: String
  CmkSecretConfig: 
    CmkSecretConfig
  CustomSecretConfig: 
    CustomSecretConfig
  Subdirectory: String
  Tags: 
    - Tag

Properties

AgentArns

(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.

Note

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.

Required: No

Type: Array of String

Minimum: 1

Maximum: 128 | 4

Update requires: No interruption

AzureAccessTier

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.

Required: No

Type: String

Allowed values: HOT | COOL | ARCHIVE

Update requires: No interruption

AzureBlobAuthenticationType

Specifies the authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS).

Required: Yes

Type: String

Allowed values: SAS | NONE

Update requires: No interruption

AzureBlobContainerUrl

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

Required: No

Type: String

Pattern: ^https://[A-Za-z0-9]((.|-+)?[A-Za-z0-9]){0,252}/[a-z0-9](-?[a-z0-9]){2,62}$

Maximum: 325

Update requires: Replacement

AzureBlobSasConfiguration

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

Note

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.

Required: No

Type: AzureBlobSasConfiguration

Update requires: No interruption

AzureBlobType

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.

Required: No

Type: String

Allowed values: BLOCK

Update requires: No interruption

CmkSecretConfig

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.

Note

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

Required: No

Type: CmkSecretConfig

Update requires: No interruption

CustomSecretConfig

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.

Note

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

Required: No

Type: CustomSecretConfig

Update requires: No interruption

Subdirectory

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

Required: No

Type: String

Pattern: ^[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}\p{C}]*$

Maximum: 1024

Update requires: No interruption

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.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the location resource ARN. For example:

arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CmkSecretConfig.SecretArn

Property description not available.

LocationArn

The ARN of the Azure Blob Storage transfer location that you created.

LocationUri

The URI of the Azure Blob Storage transfer location that you created.