AWS::DataSync::StorageSystem - AWS CloudFormation
SyntaxPropertiesReturn valuesExamples

AWS::DataSync::StorageSystem

The AWS::DataSync::StorageSystem resource creates an AWS resource for an on-premises storage system that you want DataSync Discovery to collect information about. For more information, see discovering your storage with DataSync Discovery.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::DataSync::StorageSystem",
  "Properties" : {
      "AgentArns" : [ String, ... ],
      "CloudWatchLogGroupArn" : String,
      "Name" : String,
      "ServerConfiguration" : ServerConfiguration,
      "ServerCredentials" : ServerCredentials,
      "SystemType" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::DataSync::StorageSystem
Properties:
  AgentArns: 
    - String
  CloudWatchLogGroupArn: String
  Name: String
  ServerConfiguration: 
    ServerConfiguration
  ServerCredentials: 
    ServerCredentials
  SystemType: String
  Tags: 
    - Tag

Properties

AgentArns

Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads from your on-premises storage system's management interface. You can only specify one ARN.

Required: Yes

Type: Array of String

Minimum: 1

Maximum: 128 | 1

Update requires: No interruption

CloudWatchLogGroupArn

Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging discovery job events.

Required: No

Type: String

Pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):logs:[a-z\-0-9]+:[0-9]{12}:log-group:([^:\*]*)(:\*)?$

Maximum: 562

Update requires: No interruption

Name

Specifies a familiar name for your on-premises storage system.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9\s+=._:@/-]+$

Minimum: 1

Maximum: 256

Update requires: No interruption

ServerConfiguration

Specifies the server name and network port required to connect with the management interface of your on-premises storage system.

Required: Yes

Type: ServerConfiguration

Update requires: No interruption

ServerCredentials

Specifies the user name and password for accessing your on-premises storage system's management interface.

Required: No

Type: ServerCredentials

Update requires: No interruption

SystemType

Specifies the type of on-premises storage system that you want DataSync Discovery to collect information about.

Note

DataSync Discovery currently supports NetApp Fabric-Attached Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or later.

Required: Yes

Type: String

Allowed values: NetAppONTAP

Update requires: No interruption

Tags

Specifies labels that help you categorize, filter, and search for your AWS resources. We recommend creating at least a name tag for your on-premises storage system.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the on-premises storage system that you created. For example:

arn:aws:datasync:us-east-1:111222333444:system/storage-system-abcdef01234567890

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

ConnectivityStatus

Indicates whether your DataSync agent can connect to your on-premises storage system.

SecretsManagerArn

The ARN of the secret that stores your on-premises storage system's credentials. DataSync Discovery stores these credentials in AWS Secrets Manager.

StorageSystemArn

The ARN of the on-premises storage system that you're using with DataSync Discovery.

Examples

Adding an on on-premises storage system to use with DataSync Discovery

The following example adds an on-premises storage system that you want to collect information about.

JSON

{
    "Type": "AWS::DataSync::StorageSystem",
    "Properties": {
        "AgentArns": [
            "arn:aws:datasync:us-east-1:111222333444:agent/agent-012345abcde012345"
        ],
        "CloudWatchLogGroupArn": "arn:aws:logs:us-east-1:111222333444:log-group:/aws/datasync/discovery:*",
        "Name": "MyOnPremStorage",
        "ServerConfiguration": {
            "ServerHostname": "172.16.0.0",
            "ServerPort": 443
        },
        "ServerCredentials": {
            "Username": "admin",
            "Password": "1234"
        },
        "SystemType": "NetAppONTAP",
        "Tags": [
            {
                "Key": "Migration Plan",
                "Value": "1"
            }
        ]
    }
}

YAML

Type: 'AWS::DataSync::StorageSystem'
Properties:
  AgentArns:
    - 'arn:aws:datasync:us-east-1:111222333444:agent/agent-012345abcde012345'
  CloudWatchLogGroupArn: 'arn:aws:logs:us-east-1:111222333444:log-group:/aws/datasync/discovery:*'
  Name: MyOnPremStorage
  ServerConfiguration:
    ServerHostname: 172.16.0.0
    ServerPort: 443
  ServerCredentials:
    Username: admin
    Password: '1234'
  SystemType: NetAppONTAP
  Tags:
    - Key: Migration Plan
      Value: '1'