Class CfnStorageSystem
A CloudFormation AWS::DataSync::StorageSystem
.
Inherited Members
Namespace: Amazon.CDK.AWS.DataSync
Assembly: Amazon.CDK.AWS.DataSync.dll
Syntax (csharp)
public class CfnStorageSystem : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnStorageSystem
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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.
CloudformationResource: AWS::DataSync::StorageSystem
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DataSync;
var cfnStorageSystem = new CfnStorageSystem(this, "MyCfnStorageSystem", new CfnStorageSystemProps {
AgentArns = new [] { "agentArns" },
ServerConfiguration = new ServerConfigurationProperty {
ServerHostname = "serverHostname",
// the properties below are optional
ServerPort = 123
},
SystemType = "systemType",
// the properties below are optional
CloudWatchLogGroupArn = "cloudWatchLogGroupArn",
Name = "name",
ServerCredentials = new ServerCredentialsProperty {
Password = "password",
Username = "username"
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnStorageSystem(Construct, String, ICfnStorageSystemProps) | Create a new |
CfnStorageSystem(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnStorageSystem(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
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. |
AttrConnectivityStatus | Indicates whether your DataSync agent can connect to your on-premises storage system. |
AttrSecretsManagerArn | The ARN of the secret that stores your on-premises storage system's credentials. |
AttrStorageSystemArn | The ARN of the on-premises storage system that you're using with DataSync Discovery. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
CloudWatchLogGroupArn | Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging discovery job events. |
Name | Specifies a familiar name for your on-premises storage system. |
ServerConfiguration | Specifies the server name and network port required to connect with the management interface of your on-premises storage system. |
ServerCredentials | Specifies the user name and password for accessing your on-premises storage system's management interface. |
SystemType | Specifies the type of on-premises storage system that you want DataSync Discovery to collect information about. |
Tags | Specifies labels that help you categorize, filter, and search for your AWS resources. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnStorageSystem(Construct, String, ICfnStorageSystemProps)
Create a new AWS::DataSync::StorageSystem
.
public CfnStorageSystem(Construct scope, string id, ICfnStorageSystemProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnStorageSystemProps
- resource properties.
CfnStorageSystem(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnStorageSystem(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnStorageSystem(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnStorageSystem(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
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.
public virtual string[] AgentArns { get; set; }
Property Value
System.String[]
Remarks
AttrConnectivityStatus
Indicates whether your DataSync agent can connect to your on-premises storage system.
public virtual string AttrConnectivityStatus { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ConnectivityStatus
AttrSecretsManagerArn
The ARN of the secret that stores your on-premises storage system's credentials.
public virtual string AttrSecretsManagerArn { get; }
Property Value
System.String
Remarks
DataSync Discovery stores these credentials in AWS Secrets Manager .
CloudformationAttribute: SecretsManagerArn
AttrStorageSystemArn
The ARN of the on-premises storage system that you're using with DataSync Discovery.
public virtual string AttrStorageSystemArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: StorageSystemArn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
CloudWatchLogGroupArn
Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging discovery job events.
public virtual string CloudWatchLogGroupArn { get; set; }
Property Value
System.String
Remarks
Name
Specifies a familiar name for your on-premises storage system.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
ServerConfiguration
Specifies the server name and network port required to connect with the management interface of your on-premises storage system.
public virtual object ServerConfiguration { get; set; }
Property Value
System.Object
Remarks
ServerCredentials
Specifies the user name and password for accessing your on-premises storage system's management interface.
public virtual object ServerCredentials { get; set; }
Property Value
System.Object
Remarks
SystemType
Specifies the type of on-premises storage system that you want DataSync Discovery to collect information about.
public virtual string SystemType { get; set; }
Property Value
System.String
Remarks
DataSync Discovery currently supports NetApp Fabric-Attached Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or later.
Tags
Specifies labels that help you categorize, filter, and search for your AWS resources.
public virtual TagManager Tags { get; }
Property Value
Remarks
We recommend creating at least a name tag for your on-premises storage system.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>