Class CfnLocationObjectStorageProps

Properties for defining a CfnLocationObjectStorage.

Inheritance
System.Object
CfnLocationObjectStorageProps
Namespace: Amazon.CDK.AWS.DataSync
Assembly: Amazon.CDK.AWS.DataSync.dll
Syntax (csharp)
public class CfnLocationObjectStorageProps : Object, ICfnLocationObjectStorageProps
Syntax (vb)
Public Class CfnLocationObjectStorageProps
    Inherits Object
    Implements 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;

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

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

Synopsis

Constructors

CfnLocationObjectStorageProps()

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.
ServerCertificate

Specifies a file with the certificates that are used to sign the object storage server's certificate (for example, file:///home/user/.ssh/storage_sys_certificate.pem ). The file you specify must include the following:.
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.

Constructors

CfnLocationObjectStorageProps()

public CfnLocationObjectStorageProps()

Properties

AccessKey

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

public string AccessKey { get; set; }
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.

public string[] AgentArns { get; set; }
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.

public string BucketName { get; set; }
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.

public string SecretKey { get; set; }
Property Value

System.String

Remarks

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

ServerCertificate

Specifies a file with the certificates that are used to sign the object storage server's certificate (for example, file:///home/user/.ssh/storage_sys_certificate.pem ). The file you specify must include the following:.

public string ServerCertificate { get; set; }
Property Value

System.String

Remarks

    The file can be up to 32768 bytes (before base64 encoding).

    To use this parameter, configure ServerProtocol to HTTPS .

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

    ServerHostname

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

    public string ServerHostname { get; set; }
    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).

    public Nullable<double> ServerPort { get; set; }
    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.

    public string ServerProtocol { get; set; }
    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.

    public string Subdirectory { get; set; }
    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

    Tags

    Specifies the key-value pair that represents a tag that you want to add to the resource.

    public ICfnTag[] Tags { get; set; }
    Property Value

    ICfnTag[]

    Remarks

    Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for your location.

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

    Implements