aws-cdk-lib.aws_datasync.CfnLocationAzureBlobProps

CfnLocationAzureBlobProps Struct

Properties for defining a CfnLocationAzureBlob.

CfnLocationAzureBlobProps

used as props by

• CfnLocationAzureBlob

Source

Generated code

Type last changed

v2.272.0 · 30 Sep 2026

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',
  },
  federatedIdentity: {
    awsIamRole: 'awsIamRole',
    azureOidc: {
      clientId: 'clientId',
      tenantId: 'tenantId',
    },
  },
  subdirectory: 'subdirectory',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

agentArns?optionalstring[]agent_arns?optionaltyping.List[str]agentArns?optionalList<String>AgentArns?optionalstring[]AgentArns?optional*[]*string#

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

notes

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?optionalstringazure_access_tier?optionalstrazureAccessTier?optionalStringAzureAccessTier?optionalstringAzureAccessTier?optional*string= "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 .

azureBlobAuthenticationTypestringazure_blob_authentication_typestrazureBlobAuthenticationTypeStringAzureBlobAuthenticationTypestringAzureBlobAuthenticationType*string= "SAS"required#

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

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

azureBlobContainerUrl?optionalstringazure_blob_container_url?optionalstrazureBlobContainerUrl?optionalStringAzureBlobContainerUrl?optionalstringAzureBlobContainerUrl?optional*string#

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

azureBlobSasConfiguration?optionalIResolvable | CfnLocationAzureBlob.AzureBlobSasConfigurationPropertyazure_blob_sas_configuration?optionaltyping.Union[IResolvable, AzureBlobSasConfigurationProperty]azureBlobSasConfiguration?optionalIResolvableAzureBlobSasConfiguration?optionalIResolvableAzureBlobSasConfiguration?optionalinterface{}#

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

notes

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?optionalstringazure_blob_type?optionalstrazureBlobType?optionalStringAzureBlobType?optionalstringAzureBlobType?optional*string= "BLOCK"#

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

notes

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?optionalIResolvable | CfnLocationAzureBlob.CmkSecretConfigPropertycmk_secret_config?optionaltyping.Union[IResolvable, CmkSecretConfigProperty]cmkSecretConfig?optionalIResolvableCmkSecretConfig?optionalIResolvableCmkSecretConfig?optionalinterface{}#

Specifies configuration information for a DataSync-managed secret, such as an authentication token, secret key, password, or Kerberos keytab 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?optionalIResolvable | CfnLocationAzureBlob.CustomSecretConfigPropertycustom_secret_config?optionaltyping.Union[IResolvable, CustomSecretConfigProperty]customSecretConfig?optionalIResolvableCustomSecretConfig?optionalIResolvableCustomSecretConfig?optionalinterface{}#

Specifies configuration information for a customer-managed Secrets Manager secret where a storage location credentials is stored in Secrets Manager as plain text (for authentication token, secret key, or password) or as binary (for Kerberos keytab).

notes

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.

federatedIdentity?optionalIResolvable | CfnLocationAzureBlob.AzureFederatedIdentityConfigPropertyfederated_identity?optionaltyping.Union[IResolvable, AzureFederatedIdentityConfigProperty]federatedIdentity?optionalIResolvableFederatedIdentity?optionalIResolvableFederatedIdentity?optionalinterface{}#

Specifies the identity federation configuration that DataSync uses to access your Azure Blob Storage container using an OpenID Connect (OIDC) token.

subdirectory?optionalstringsubdirectory?optionalstrsubdirectory?optionalStringSubdirectory?optionalstringSubdirectory?optional*string#

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

tags?optionalCfnTag[]tags?optionaltyping.List[CfnTag]tags?optionalList<CfnTag>Tags?optionalCfnTag[]Tags?optional*[]CfnTag#

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.