Skip to main content

location_azure_blobs

Creates, updates, deletes, gets or lists a location_azure_blobs resource.

Overview​

Namelocation_azure_blobs
TypeResource
Idaws.datasync.location_azure_blobs

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
access_tierstringThe 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. (HOT, COOL, ARCHIVE)
agent_arnsarrayThe ARNs of the DataSync agents that can connect with your Azure Blob Storage container.
authentication_typestringThe authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS). (SAS, NONE)
blob_typestringThe 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. (BLOCK)
cmk_secret_configobjectDescribes configuration information for a DataSync-managed secret, such as an authentication token that DataSync uses to access a specific storage location, with a customer-managed KMS key.
creation_timestring (date-time)The time that your Azure Blob Storage transfer location was created.
custom_secret_configobjectDescribes configuration information for a customer-managed secret, such as an authentication token that DataSync uses to access a specific storage location, with a customer-managed Identity and Access Management (IAM) role that provides access to the secret.
location_arnstringThe ARN of your Azure Blob Storage transfer location. (pattern: <code>^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$</code>)
location_uristringThe URL of the Azure Blob Storage container involved in your transfer. (pattern: <code>^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+):​//[a-zA-Z0-9.:/-]+$</code>)
managed_secret_configobjectDescribes configuration information for a DataSync-managed secret, such as an authentication token that DataSync uses to access a specific storage location. DataSync uses the default Amazon Web Services-managed KMS key to encrypt this secret in Secrets Manager.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_location_azure_blobselectregionProvides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.
create_location_azure_blobinsertregion, ContainerUrl, AuthenticationTypeCreates a transfer location for a Microsoft Azure Blob Storage container. 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.
update_location_azure_blobupdateregion, LocationArnModifies the following configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with Azure Blob Storage.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples​

Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.

SELECT
access_tier,
agent_arns,
authentication_type,
blob_type,
cmk_secret_config,
creation_time,
custom_secret_config,
location_arn,
location_uri,
managed_secret_config
FROM aws.datasync.location_azure_blobs
WHERE region = '{{ region }}' -- required
;

INSERT examples​

Creates a transfer location for a Microsoft Azure Blob Storage container. 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.

INSERT INTO aws.datasync.location_azure_blobs (
ContainerUrl,
AuthenticationType,
SasConfiguration,
BlobType,
AccessTier,
Subdirectory,
AgentArns,
Tags,
CmkSecretConfig,
CustomSecretConfig,
region
)
SELECT 
'{{ ContainerUrl }}' /* required */,
'{{ AuthenticationType }}' /* required */,
'{{ SasConfiguration }}',
'{{ BlobType }}',
'{{ AccessTier }}',
'{{ Subdirectory }}',
'{{ AgentArns }}',
'{{ Tags }}',
'{{ CmkSecretConfig }}',
'{{ CustomSecretConfig }}',
'{{ region }}'
RETURNING
location_arn
;

UPDATE examples​

Modifies the following configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with Azure Blob Storage.

UPDATE aws.datasync.location_azure_blobs
SET 
LocationArn = '{{ LocationArn }}',
Subdirectory = '{{ Subdirectory }}',
AuthenticationType = '{{ AuthenticationType }}',
SasConfiguration = '{{ SasConfiguration }}',
BlobType = '{{ BlobType }}',
AccessTier = '{{ AccessTier }}',
AgentArns = '{{ AgentArns }}',
CmkSecretConfig = '{{ CmkSecretConfig }}',
CustomSecretConfig = '{{ CustomSecretConfig }}'
WHERE 
region = '{{ region }}' --required
AND LocationArn = '{{ LocationArn }}' --required;
Last updated on