Interface ICfnLocationObjectStorageProps

Properties for defining a CfnLocationObjectStorage.

Namespace: Amazon.CDK.AWS.DataSync

Assembly: Amazon.CDK.AWS.DataSync.dll

Syntax (csharp)

public interface ICfnLocationObjectStorageProps

Syntax (vb)

Public Interface ICfnLocationObjectStorageProps

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html

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;

CfnLocationObjectStorageProps cfnLocationObjectStorageProps = new CfnLocationObjectStorageProps {
    AgentArns = new [] { "agentArns" },

    // the properties below are optional
    AccessKey = "accessKey",
    BucketName = "bucketName",
    SecretKey = "secretKey",
    ServerHostname = "serverHostname",
    ServerPort = 123,
    ServerProtocol = "serverProtocol",
    Subdirectory = "subdirectory",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};

Synopsis

Properties

AccessKey	Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
AgentArns	Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.
BucketName	Specifies the name of the object storage bucket involved in the transfer.
SecretKey	Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
ServerHostname	Specifies the domain name or IP address of the object storage server.
ServerPort	Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
ServerProtocol	Specifies the protocol that your object storage server uses to communicate.
Subdirectory	Specifies the object prefix for your object storage server.
Tags	Specifies the key-value pair that represents a tag that you want to add to the resource.

Properties

AccessKey

Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.

virtual string AccessKey { get; }

Property Value

System.String

Remarks

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

AgentArns

Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.

string[] AgentArns { get; }

Property Value

System.String[]

Remarks

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

BucketName

Specifies the name of the object storage bucket involved in the transfer.

virtual string BucketName { get; }

Property Value

System.String

Remarks

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

SecretKey

Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.

virtual string SecretKey { get; }

Property Value

System.String

Remarks

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

ServerHostname

Specifies the domain name or IP address of the object storage server.

virtual string ServerHostname { get; }

Property Value

System.String

Remarks

A DataSync agent uses this hostname to mount the object storage server in a network.

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

ServerPort

Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).

virtual Nullable<double> ServerPort { get; }

Property Value

System.Nullable<System.Double>

Remarks

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

ServerProtocol

Specifies the protocol that your object storage server uses to communicate.

virtual string ServerProtocol { get; }

Property Value

System.String

Remarks

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

Subdirectory

Specifies the object prefix for your object storage server.

virtual string Subdirectory { get; }

Property Value

System.String

Remarks

If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.

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