CfnStorageSystem

class aws_cdk.aws_datasync.CfnStorageSystem(scope, id, *, agent_arns, server_configuration, system_type, cloud_watch_log_group_arn=None, name=None, server_credentials=None, tags=None)

Bases: CfnResource

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.

CloudformationResource:: AWS::DataSync::StorageSystem
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-storagesystem.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_datasync as datasync

cfn_storage_system = datasync.CfnStorageSystem(self, "MyCfnStorageSystem",
    agent_arns=["agentArns"],
    server_configuration=datasync.CfnStorageSystem.ServerConfigurationProperty(
        server_hostname="serverHostname",

        # the properties below are optional
        server_port=123
    ),
    system_type="systemType",

    # the properties below are optional
    cloud_watch_log_group_arn="cloudWatchLogGroupArn",
    name="name",
    server_credentials=datasync.CfnStorageSystem.ServerCredentialsProperty(
        password="password",
        username="username"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Create a new AWS::DataSync::StorageSystem.

Parameters:

scope (Construct) –
- scope in which this resource is defined.
id (str) –
- scoped id of the resource.
agent_arns (Sequence[str]) – Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads from your on-premises storage system’s management interface.
server_configuration (Union[IResolvable, ServerConfigurationProperty, Dict[str, Any]]) – Specifies the server name and network port required to connect with the management interface of your on-premises storage system.
system_type (str) – Specifies the type of on-premises storage system that you want DataSync Discovery to collect information about. .. epigraph:: DataSync Discovery currently supports NetApp Fabric-Attached Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or later.
cloud_watch_log_group_arn (Optional[str]) – Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging discovery job events.
name (Optional[str]) – Specifies a familiar name for your on-premises storage system.
server_credentials (Union[IResolvable, ServerCredentialsProperty, Dict[str, Any], None]) – Specifies the user name and password for accessing your on-premises storage system’s management interface.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str)
value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (Optional[RemovalPolicy])
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type:

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:: attribute_name (str) – The name of the attribute.
Return type:: Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:: key (str)
See:
Return type:: Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) –

tree inspector to collect and process attributes.

Return type:

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::DataSync::StorageSystem'

agent_arns

Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads from your on-premises storage system’s management interface.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-storagesystem.html#cfn-datasync-storagesystem-agentarns

attr_connectivity_status

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

CloudformationAttribute:: ConnectivityStatus

attr_secrets_manager_arn

The ARN of the secret that stores your on-premises storage system’s credentials.

DataSync Discovery stores these credentials in AWS Secrets Manager .

CloudformationAttribute:: SecretsManagerArn

attr_storage_system_arn

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

CloudformationAttribute:: StorageSystemArn

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

cloud_watch_log_group_arn

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

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-storagesystem.html#cfn-datasync-storagesystem-cloudwatchloggrouparn

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

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

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-storagesystem.html#cfn-datasync-storagesystem-name

node: The construct tree node associated with this construct.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

server_configuration

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

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-storagesystem.html#cfn-datasync-storagesystem-serverconfiguration

server_credentials

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

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-storagesystem.html#cfn-datasync-storagesystem-servercredentials

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

system_type

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.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-storagesystem.html#cfn-datasync-storagesystem-systemtype

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.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-storagesystem.html#cfn-datasync-storagesystem-tags

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:: x (Any)
Return type:: bool
Returns:: The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters:: construct (IConstruct)
Return type:: bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:: x (Any)
Return type:: bool

ServerConfigurationProperty

class CfnStorageSystem.ServerConfigurationProperty(*, server_hostname, server_port=None)

Bases: object

The network settings that DataSync Discovery uses to connect with your on-premises storage system’s management interface.

Parameters:

server_hostname (str) – The domain name or IP address of your storage system’s management interface.
server_port (Union[int, float, None]) – The network port for accessing the storage system’s management interface.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-storagesystem-serverconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_datasync as datasync

server_configuration_property = datasync.CfnStorageSystem.ServerConfigurationProperty(
    server_hostname="serverHostname",

    # the properties below are optional
    server_port=123
)

Attributes

server_hostname

The domain name or IP address of your storage system’s management interface.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-storagesystem-serverconfiguration.html#cfn-datasync-storagesystem-serverconfiguration-serverhostname

server_port

The network port for accessing the storage system’s management interface.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-storagesystem-serverconfiguration.html#cfn-datasync-storagesystem-serverconfiguration-serverport

ServerCredentialsProperty

class CfnStorageSystem.ServerCredentialsProperty(*, password, username)

Bases: object

The credentials that provide DataSync Discovery read access to your on-premises storage system’s management interface.

DataSync Discovery stores these credentials in AWS Secrets Manager . For more information, see Accessing your on-premises storage system .

Parameters:

password (str) – Specifies the password for your storage system’s management interface.
username (str) – Specifies the user name for your storage system’s management interface.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-storagesystem-servercredentials.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_datasync as datasync

server_credentials_property = datasync.CfnStorageSystem.ServerCredentialsProperty(
    password="password",
    username="username"
)

Attributes

password

Specifies the password for your storage system’s management interface.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-storagesystem-servercredentials.html#cfn-datasync-storagesystem-servercredentials-password

username

Specifies the user name for your storage system’s management interface.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-storagesystem-servercredentials.html#cfn-datasync-storagesystem-servercredentials-username