Package software.amazon.awscdk.services.datasync

Class CfnLocationAzureBlob

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.datasync.CfnLocationAzureBlob
All Implemented Interfaces:
IInspectable, ILocationAzureBlobRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:07.993Z") @Stability(Stable) public class CfnLocationAzureBlob extends CfnResource implements IInspectable, ILocationAzureBlobRef, ITaggableV2
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 .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.datasync.*;
 CfnLocationAzureBlob cfnLocationAzureBlob = CfnLocationAzureBlob.Builder.create(this, "MyCfnLocationAzureBlob")
         .azureBlobAuthenticationType("azureBlobAuthenticationType")
         // the properties below are optional
         .agentArns(List.of("agentArns"))
         .azureAccessTier("azureAccessTier")
         .azureBlobContainerUrl("azureBlobContainerUrl")
         .azureBlobSasConfiguration(AzureBlobSasConfigurationProperty.builder()
                 .azureBlobSasToken("azureBlobSasToken")
                 .build())
         .azureBlobType("azureBlobType")
         .cmkSecretConfig(CmkSecretConfigProperty.builder()
                 .kmsKeyArn("kmsKeyArn")
                 .secretArn("secretArn")
                 .build())
         .customSecretConfig(CustomSecretConfigProperty.builder()
                 .secretAccessRoleArn("secretAccessRoleArn")
                 .secretArn("secretArn")
                 .build())
         .subdirectory("subdirectory")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnLocationAzureBlob

      protected CfnLocationAzureBlob(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnLocationAzureBlob

      protected CfnLocationAzureBlob(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnLocationAzureBlob

      @Stability(Stable) public CfnLocationAzureBlob(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnLocationAzureBlobProps props)
      Create a new AWS::DataSync::LocationAzureBlob.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • isCfnLocationAzureBlob

      @Stability(Stable) @NotNull public static Boolean isCfnLocationAzureBlob(@NotNull Object x)
      Checks whether the given object is a CfnLocationAzureBlob.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCmkSecretConfigSecretArn

      @Stability(Stable) @NotNull public String getAttrCmkSecretConfigSecretArn()
      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 .

    • getAttrLocationArn

      @Stability(Stable) @NotNull public String getAttrLocationArn()
      The ARN of the Azure Blob Storage transfer location that you created.

    • getAttrLocationUri

      @Stability(Stable) @NotNull public String getAttrLocationUri()
      The URI of the Azure Blob Storage transfer location that you created.

    • getAttrManagedSecretConfig

      @Stability(Stable) @NotNull public IResolvable getAttrManagedSecretConfig()
      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.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getLocationAzureBlobRef

      @Stability(Stable) @NotNull public LocationAzureBlobReference getLocationAzureBlobRef()
      A reference to a LocationAzureBlob resource.
      Specified by:
      getLocationAzureBlobRef in interface ILocationAzureBlobRef

    • getAzureBlobAuthenticationType

      @Stability(Stable) @NotNull public String getAzureBlobAuthenticationType()
      Specifies the authentication method DataSync uses to access your Azure Blob Storage.

    • setAzureBlobAuthenticationType

      @Stability(Stable) public void setAzureBlobAuthenticationType(@NotNull String value)
      Specifies the authentication method DataSync uses to access your Azure Blob Storage.

    • getAgentArns

      @Stability(Stable) @Nullable public List<String> getAgentArns()
      (Optional) Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container.

    • setAgentArns

      @Stability(Stable) public void setAgentArns(@Nullable List<String> value)
      (Optional) Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container.

    • getAzureAccessTier

      @Stability(Stable) @Nullable public String getAzureAccessTier()
      Specifies the access tier that you want your objects or files transferred into.

    • setAzureAccessTier

      @Stability(Stable) public void setAzureAccessTier(@Nullable String value)
      Specifies the access tier that you want your objects or files transferred into.

    • getAzureBlobContainerUrl

      @Stability(Stable) @Nullable public String getAzureBlobContainerUrl()
      Specifies the URL of the Azure Blob Storage container involved in your transfer.

    • setAzureBlobContainerUrl

      @Stability(Stable) public void setAzureBlobContainerUrl(@Nullable String value)
      Specifies the URL of the Azure Blob Storage container involved in your transfer.

    • getAzureBlobSasConfiguration

      @Stability(Stable) @Nullable public Object getAzureBlobSasConfiguration()
      Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage.

      Returns union: either IResolvable or CfnLocationAzureBlob.AzureBlobSasConfigurationProperty

    • setAzureBlobSasConfiguration

      @Stability(Stable) public void setAzureBlobSasConfiguration(@Nullable IResolvable value)
      Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage.

    • setAzureBlobSasConfiguration

      @Stability(Stable) public void setAzureBlobSasConfiguration(@Nullable CfnLocationAzureBlob.AzureBlobSasConfigurationProperty value)
      Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage.

    • getAzureBlobType

      @Stability(Stable) @Nullable public String getAzureBlobType()
      Specifies the type of blob that you want your objects or files to be when transferring them into Azure Blob Storage.

    • setAzureBlobType

      @Stability(Stable) public void setAzureBlobType(@Nullable String value)
      Specifies the type of blob that you want your objects or files to be when transferring them into Azure Blob Storage.

    • getCmkSecretConfig

      @Stability(Stable) @Nullable public Object getCmkSecretConfig()
      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 .

      Returns union: either IResolvable or CfnLocationAzureBlob.CmkSecretConfigProperty

    • setCmkSecretConfig

      @Stability(Stable) public void setCmkSecretConfig(@Nullable IResolvable value)
      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 .

    • setCmkSecretConfig

      @Stability(Stable) public void setCmkSecretConfig(@Nullable CfnLocationAzureBlob.CmkSecretConfigProperty value)
      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 .

    • getCustomSecretConfig

      @Stability(Stable) @Nullable public Object getCustomSecretConfig()
      Specifies configuration information for a customer-managed Secrets Manager secret where a storage location authentication token or secret key is stored in plain text.

      Returns union: either IResolvable or CfnLocationAzureBlob.CustomSecretConfigProperty

    • setCustomSecretConfig

      @Stability(Stable) public void setCustomSecretConfig(@Nullable IResolvable value)
      Specifies configuration information for a customer-managed Secrets Manager secret where a storage location authentication token or secret key is stored in plain text.

    • setCustomSecretConfig

      @Stability(Stable) public void setCustomSecretConfig(@Nullable CfnLocationAzureBlob.CustomSecretConfigProperty value)
      Specifies configuration information for a customer-managed Secrets Manager secret where a storage location authentication token or secret key is stored in plain text.

    • getSubdirectory

      @Stability(Stable) @Nullable public String getSubdirectory()
      Specifies path segments if you want to limit your transfer to a virtual directory in your container (for example, /my/images ).

    • setSubdirectory

      @Stability(Stable) public void setSubdirectory(@Nullable String value)
      Specifies path segments if you want to limit your transfer to a virtual directory in your container (for example, /my/images ).

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Specifies labels that help you categorize, filter, and search for your AWS resources.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Specifies labels that help you categorize, filter, and search for your AWS resources.