Package software.amazon.awscdk.services.datasync

Class CfnStorageSystem

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.datasync.CfnStorageSystem
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.212Z") @Stability(Stable) public class CfnStorageSystem extends CfnResource implements IInspectable
A CloudFormation 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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.datasync.*;
 CfnStorageSystem cfnStorageSystem = CfnStorageSystem.Builder.create(this, "MyCfnStorageSystem")
         .agentArns(List.of("agentArns"))
         .serverConfiguration(ServerConfigurationProperty.builder()
                 .serverHostname("serverHostname")
                 // the properties below are optional
                 .serverPort(123)
                 .build())
         .systemType("systemType")
         // the properties below are optional
         .cloudWatchLogGroupArn("cloudWatchLogGroupArn")
         .name("name")
         .serverCredentials(ServerCredentialsProperty.builder()
                 .password("password")
                 .username("username")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnStorageSystem

      protected CfnStorageSystem(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnStorageSystem

      protected CfnStorageSystem(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnStorageSystem

      @Stability(Stable) public CfnStorageSystem(@NotNull Construct scope, @NotNull String id, @NotNull CfnStorageSystemProps props)
      Create a new AWS::DataSync::StorageSystem.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrConnectivityStatus

      @Stability(Stable) @NotNull public String getAttrConnectivityStatus()
      Indicates whether your DataSync agent can connect to your on-premises storage system.

    • getAttrSecretsManagerArn

      @Stability(Stable) @NotNull public String getAttrSecretsManagerArn()
      The ARN of the secret that stores your on-premises storage system's credentials.

      DataSync Discovery stores these credentials in AWS Secrets Manager .

    • getAttrStorageSystemArn

      @Stability(Stable) @NotNull public String getAttrStorageSystemArn()
      The ARN of the on-premises storage system that you're using with DataSync Discovery.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      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.

    • getAgentArns

      @Stability(Stable) @NotNull public List<String> getAgentArns()
      Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads from your on-premises storage system's management interface.

    • setAgentArns

      @Stability(Stable) public void setAgentArns(@NotNull List<String> value)
      Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads from your on-premises storage system's management interface.

    • getServerConfiguration

      @Stability(Stable) @NotNull public Object getServerConfiguration()
      Specifies the server name and network port required to connect with the management interface of your on-premises storage system.

    • setServerConfiguration

      @Stability(Stable) public void setServerConfiguration(@NotNull IResolvable value)
      Specifies the server name and network port required to connect with the management interface of your on-premises storage system.

    • setServerConfiguration

      @Stability(Stable) public void setServerConfiguration(@NotNull CfnStorageSystem.ServerConfigurationProperty value)
      Specifies the server name and network port required to connect with the management interface of your on-premises storage system.

    • getSystemType

      @Stability(Stable) @NotNull public String getSystemType()
      Specifies the type of on-premises storage system that you want DataSync Discovery to collect information about.

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

    • setSystemType

      @Stability(Stable) public void setSystemType(@NotNull String value)
      Specifies the type of on-premises storage system that you want DataSync Discovery to collect information about.

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

    • getCloudWatchLogGroupArn

      @Stability(Stable) @Nullable public String getCloudWatchLogGroupArn()
      Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging discovery job events.

    • setCloudWatchLogGroupArn

      @Stability(Stable) public void setCloudWatchLogGroupArn(@Nullable String value)
      Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging discovery job events.

    • getName

      @Stability(Stable) @Nullable public String getName()
      Specifies a familiar name for your on-premises storage system.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      Specifies a familiar name for your on-premises storage system.

    • getServerCredentials

      @Stability(Stable) @Nullable public Object getServerCredentials()
      Specifies the user name and password for accessing your on-premises storage system's management interface.

    • setServerCredentials

      @Stability(Stable) public void setServerCredentials(@Nullable IResolvable value)
      Specifies the user name and password for accessing your on-premises storage system's management interface.

    • setServerCredentials

      @Stability(Stable) public void setServerCredentials(@Nullable CfnStorageSystem.ServerCredentialsProperty value)
      Specifies the user name and password for accessing your on-premises storage system's management interface.