location_azure_blobs

Creates, updates, deletes or gets a location_azure_blob resource or lists location_azure_blobs in a region

Overview

Name	location_azure_blobs
Type	Resource
Description	Resource Type definition for AWS::DataSync::LocationAzureBlob.
Id	awscc.datasync.location_azure_blobs

Fields

get (all properties)

Name	Datatype	Description
agent_arns	array	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.
azure_blob_authentication_type	string	The specific authentication type that you want DataSync to use to access your Azure Blob Container.
▶azure_blob_sas_configuration	object	Specifies the shared access signature (SAS) that DataSync uses to access your Azure Blob Storage container.
azure_blob_container_url	string	The URL of the Azure Blob container that was described.
azure_blob_type	string	Specifies a blob type for the objects you're transferring into your Azure Blob Storage container.
azure_access_tier	string	Specifies an access tier for the objects you're transferring into your Azure Blob Storage container.
subdirectory	string	The subdirectory in the Azure Blob Container that is used to read data from the Azure Blob Source Location.
▶tags	array	An array of key-value pairs to apply to this resource.
location_arn	string	The Amazon Resource Name (ARN) of the Azure Blob Location that is created.
location_uri	string	The URL of the Azure Blob Location that was described.
▶cmk_secret_config	object	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, and a customer-managed AWS KMS key.
▶custom_secret_config	object	Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret.
▶managed_secret_config	object	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.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
location_arn	string	The Amazon Resource Name (ARN) of the Azure Blob Location that is created.
region	string	AWS region.

For more information, see AWS::DataSync::LocationAzureBlob.

Methods

Name	Resource	Accessible by	Required Params
create_resource	location_azure_blobs	INSERT	AzureBlobAuthenticationType, region
delete_resource	location_azure_blobs	DELETE	Identifier, region
update_resource	location_azure_blobs	UPDATE	Identifier, PatchDocument, region
list_resources	location_azure_blobs_list_only	SELECT	region
get_resource	location_azure_blobs	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual location_azure_blob.

SELECT
  region,
  agent_arns,
  azure_blob_authentication_type,
  azure_blob_sas_configuration,
  azure_blob_container_url,
  azure_blob_type,
  azure_access_tier,
  subdirectory,
  tags,
  location_arn,
  location_uri,
  cmk_secret_config,
  custom_secret_config,
  managed_secret_config
FROM awscc.datasync.location_azure_blobs
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ location_arn }}';

list (identifiers only)

Lists all location_azure_blobs in a region.

SELECT
  region,
  location_arn
FROM awscc.datasync.location_azure_blobs_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new location_azure_blob resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.datasync.location_azure_blobs (
  AzureBlobAuthenticationType,
  region
)
SELECT
  '{{ azure_blob_authentication_type }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.datasync.location_azure_blobs (
  AgentArns,
  AzureBlobAuthenticationType,
  AzureBlobSasConfiguration,
  AzureBlobContainerUrl,
  AzureBlobType,
  AzureAccessTier,
  Subdirectory,
  Tags,
  CmkSecretConfig,
  CustomSecretConfig,
  region
)
SELECT
  '{{ agent_arns }}',
  '{{ azure_blob_authentication_type }}',
  '{{ azure_blob_sas_configuration }}',
  '{{ azure_blob_container_url }}',
  '{{ azure_blob_type }}',
  '{{ azure_access_tier }}',
  '{{ subdirectory }}',
  '{{ tags }}',
  '{{ cmk_secret_config }}',
  '{{ custom_secret_config }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: location_azure_blob
    props:
      - name: agent_arns
        value:
          - '{{ agent_arns[0] }}'
      - name: azure_blob_authentication_type
        value: '{{ azure_blob_authentication_type }}'
      - name: azure_blob_sas_configuration
        value:
          azure_blob_sas_token: '{{ azure_blob_sas_token }}'
      - name: azure_blob_container_url
        value: '{{ azure_blob_container_url }}'
      - name: azure_blob_type
        value: '{{ azure_blob_type }}'
      - name: azure_access_tier
        value: '{{ azure_access_tier }}'
      - name: subdirectory
        value: '{{ subdirectory }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: cmk_secret_config
        value:
          secret_arn: '{{ secret_arn }}'
          kms_key_arn: '{{ kms_key_arn }}'
      - name: custom_secret_config
        value:
          secret_arn: '{{ secret_arn }}'
          secret_access_role_arn: '{{ secret_access_role_arn }}'

UPDATE example

Use the following StackQL query and manifest file to update a location_azure_blob resource, using stack-deploy.

/*+ update */
UPDATE awscc.datasync.location_azure_blobs
SET PatchDocument = string('{{ {
    "AgentArns": agent_arns,
    "AzureBlobAuthenticationType": azure_blob_authentication_type,
    "AzureBlobSasConfiguration": azure_blob_sas_configuration,
    "AzureBlobType": azure_blob_type,
    "AzureAccessTier": azure_access_tier,
    "Subdirectory": subdirectory,
    "Tags": tags,
    "CustomSecretConfig": custom_secret_config
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ location_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.datasync.location_azure_blobs
WHERE
  Identifier = '{{ location_arn }}' AND
  region = 'us-east-1';

Permissions

To operate on the location_azure_blobs resource, the following permissions are required:

Create

datasync:CreateLocationAzureBlob,
datasync:DescribeLocationAzureBlob,
datasync:TagResource,
datasync:ListTagsForResource,
secretsmanager:CreateSecret,
secretsmanager:PutSecretValue,
secretsmanager:DeleteSecret,
iam:CreateServiceLinkedRole,
iam:PassRole,
kms:Encrypt,
kms:Decrypt,
kms:GenerateDataKey

Read

datasync:DescribeLocationAzureBlob,
datasync:ListTagsForResource

Update

datasync:DescribeLocationAzureBlob,
datasync:ListTagsForResource,
datasync:TagResource,
datasync:UntagResource,
datasync:UpdateLocationAzureBlob,
secretsmanager:UpdateSecret,
secretsmanager:DeleteSecret,
secretsmanager:PutSecretValue,
secretsmanager:CreateSecret,
iam:CreateServiceLinkedRole,
iam:PassRole,
kms:Encrypt,
kms:Decrypt,
kms:GenerateDataKey

Delete

datasync:DeleteLocation,
secretsmanager:DeleteSecret

List

datasync:ListLocations