interface CfnLocationAzureBlobProps

Language	Type name
.NET	`Amazon.CDK.AWS.DataSync.CfnLocationAzureBlobProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsdatasync#CfnLocationAzureBlobProps`
Java	`software.amazon.awscdk.services.datasync.CfnLocationAzureBlobProps`
Python	`aws_cdk.aws_datasync.CfnLocationAzureBlobProps`
TypeScript	`aws-cdk-lib` » `aws_datasync` » `CfnLocationAzureBlobProps`

Properties for defining a CfnLocationAzureBlob.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_datasync as datasync } from 'aws-cdk-lib';
const cfnLocationAzureBlobProps: datasync.CfnLocationAzureBlobProps = {
  azureBlobAuthenticationType: 'azureBlobAuthenticationType',

  // the properties below are optional
  agentArns: ['agentArns'],
  azureAccessTier: 'azureAccessTier',
  azureBlobContainerUrl: 'azureBlobContainerUrl',
  azureBlobSasConfiguration: {
    azureBlobSasToken: 'azureBlobSasToken',
  },
  azureBlobType: 'azureBlobType',
  cmkSecretConfig: {
    kmsKeyArn: 'kmsKeyArn',
    secretArn: 'secretArn',
  },
  customSecretConfig: {
    secretAccessRoleArn: 'secretAccessRoleArn',
    secretArn: 'secretArn',
  },
  subdirectory: 'subdirectory',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
azureBlobAuthenticationType	`string`	Specifies the authentication method DataSync uses to access your Azure Blob Storage.
agentArns?	`string[]`	(Optional) Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container.
azureAccessTier?	`string`	Specifies the access tier that you want your objects or files transferred into.
azureBlobContainerUrl?	`string`	Specifies the URL of the Azure Blob Storage container involved in your transfer.
azureBlobSasConfiguration?	`IResolvable` `\|` `AzureBlobSasConfigurationProperty`	Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage.
azureBlobType?	`string`	Specifies the type of blob that you want your objects or files to be when transferring them into Azure Blob Storage.
cmkSecretConfig?	`IResolvable` `\|` `CmkSecretConfigProperty`	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 .
customSecretConfig?	`IResolvable` `\|` `CustomSecretConfigProperty`	Specifies configuration information for a customer-managed Secrets Manager secret where a storage location authentication token or secret key is stored in plain text.
subdirectory?	`string`	Specifies path segments if you want to limit your transfer to a virtual directory in your container (for example, `/my/images` ).
tags?	`CfnTag[]`	Specifies labels that help you categorize, filter, and search for your AWS resources.

azureBlobAuthenticationType

Type: string

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

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

agentArns?

Type: string[] (optional)

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

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.

azureAccessTier?

Type: string (optional, default: "HOT")

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 .

azureBlobContainerUrl?

Type: string (optional)

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

azureBlobSasConfiguration?

Type: IResolvable | AzureBlobSasConfigurationProperty (optional)

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.

azureBlobType?

Type: string (optional, default: "BLOCK")

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 .

cmkSecretConfig?

Type: IResolvable | CmkSecretConfigProperty (optional)

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.

customSecretConfig?

Type: IResolvable | CustomSecretConfigProperty (optional)

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.

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

subdirectory?

Type: string (optional)

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

tags?

Type: CfnTag[] (optional)

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.