storage_systems

Creates, updates, deletes or gets a storage_system resource or lists storage_systems in a region

Overview

Name	storage_systems
Type	Resource
Description	Resource schema for AWS::DataSync::StorageSystem.
Id	aws.datasync.storage_systems

Fields

Name	Datatype	Description
server_configuration	object	The server name and network port required to connect with the management interface of the on-premises storage system.
server_credentials	object	The username and password for accessing your on-premises storage system's management interface.
secrets_manager_arn	string	The ARN of a secret stored by AWS Secrets Manager.
system_type	string	The type of on-premises storage system that DataSync Discovery will analyze.
agent_arns	array	The ARN of the DataSync agent that connects to and reads from the on-premises storage system's management interface.
cloud_watch_log_group_arn	string	The ARN of the Amazon CloudWatch log group used to monitor and log discovery job events.
name	string	A familiar name for the on-premises storage system.
tags	array	An array of key-value pairs to apply to this resource.
storage_system_arn	string	The ARN of the on-premises storage system added to DataSync Discovery.
connectivity_status	string	Indicates whether the DataSync agent can access the on-premises storage system.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ServerConfiguration, SystemType, AgentArns, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all storage_systems in a region.

SELECT
region,
server_configuration,
server_credentials,
secrets_manager_arn,
system_type,
agent_arns,
cloud_watch_log_group_arn,
name,
tags,
storage_system_arn,
connectivity_status
FROM aws.datasync.storage_systems
WHERE region = 'us-east-1';

Gets all properties from an individual storage_system.

SELECT
region,
server_configuration,
server_credentials,
secrets_manager_arn,
system_type,
agent_arns,
cloud_watch_log_group_arn,
name,
tags,
storage_system_arn,
connectivity_status
FROM aws.datasync.storage_systems
WHERE region = 'us-east-1' AND data__Identifier = '<StorageSystemArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.datasync.storage_systems (
 ServerConfiguration,
 SystemType,
 AgentArns,
 region
)
SELECT 
'{{ ServerConfiguration }}',
 '{{ SystemType }}',
 '{{ AgentArns }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.datasync.storage_systems (
 ServerConfiguration,
 ServerCredentials,
 SystemType,
 AgentArns,
 CloudWatchLogGroupArn,
 Name,
 Tags,
 region
)
SELECT 
 '{{ ServerConfiguration }}',
 '{{ ServerCredentials }}',
 '{{ SystemType }}',
 '{{ AgentArns }}',
 '{{ CloudWatchLogGroupArn }}',
 '{{ Name }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: storage_system
    props:
      - name: ServerConfiguration
        value:
          ServerHostname: '{{ ServerHostname }}'
          ServerPort: '{{ ServerPort }}'
      - name: ServerCredentials
        value:
          Username: '{{ Username }}'
          Password: '{{ Password }}'
      - name: SystemType
        value: '{{ SystemType }}'
      - name: AgentArns
        value:
          - '{{ AgentArns[0] }}'
      - name: CloudWatchLogGroupArn
        value: '{{ CloudWatchLogGroupArn }}'
      - name: Name
        value: '{{ Name }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.datasync.storage_systems
WHERE data__Identifier = '<StorageSystemArn>'
AND region = 'us-east-1';

Permissions

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

Create

datasync:AddStorageSystem,
datasync:DescribeStorageSystem,
datasync:ListTagsForResource,
datasync:TagResource,
secretsmanager:CreateSecret,
secretsmanager:DescribeSecret,
iam:CreateServiceLinkedRole

Read

datasync:DescribeStorageSystem,
datasync:ListTagsForResource,
secretsmanager:DescribeSecret

Update

datasync:UpdateStorageSystem,
datasync:DescribeStorageSystem,
datasync:ListTagsForResource,
datasync:TagResource,
datasync:UntagResource,
secretsmanager:DescribeSecret,
secretsmanager:PutSecretValue

Delete

datasync:DescribeStorageSystem,
datasync:RemoveStorageSystem,
secretsmanager:DescribeSecret,
secretsmanager:DeleteSecret

List

datasync:ListStorageSystems