CfnLocationObjectStorageProps

class aws_cdk.aws_datasync.CfnLocationObjectStorageProps(*, agent_arns, access_key=None, bucket_name=None, secret_key=None, server_certificate=None, server_hostname=None, server_port=None, server_protocol=None, subdirectory=None, tags=None)

Bases: object

Properties for defining a CfnLocationObjectStorage.

Parameters:

agent_arns (Sequence[str]) – Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.
access_key (Optional[str]) – Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
bucket_name (Optional[str]) – Specifies the name of the object storage bucket involved in the transfer.
secret_key (Optional[str]) – Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
server_certificate (Optional[str]) – 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:. - The certificate of the signing certificate authority (CA) - Any intermediate certificates - base64 encoding - A .pem extension The file can be up to 32768 bytes (before base64 encoding). To use this parameter, configure ServerProtocol to HTTPS .
server_hostname (Optional[str]) – Specifies the domain name or IP address of the object storage server. A DataSync agent uses this hostname to mount the object storage server in a network.
server_port (Union[int, float, None]) – Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
server_protocol (Optional[str]) – Specifies the protocol that your object storage server uses to communicate.
subdirectory (Optional[str]) – Specifies the object prefix for your object storage server. 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.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Specifies the key-value pair that represents a tag that you want to add to the resource. 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

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_location_object_storage_props = datasync.CfnLocationObjectStorageProps(
    agent_arns=["agentArns"],

    # the properties below are optional
    access_key="accessKey",
    bucket_name="bucketName",
    secret_key="secretKey",
    server_certificate="serverCertificate",
    server_hostname="serverHostname",
    server_port=123,
    server_protocol="serverProtocol",
    subdirectory="subdirectory",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

access_key

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

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

agent_arns

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

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

bucket_name

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

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

secret_key

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

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

server_certificate

.

The certificate of the signing certificate authority (CA)
Any intermediate certificates
base64 encoding
A .pem extension

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
Type:: 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

server_hostname

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

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

server_port

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

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

server_protocol

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

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.

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.

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