Package software.amazon.awscdk.services.datasync

Interface CfnLocationObjectStorageProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLocationObjectStorageProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.89.0 (build 2f74b3e)",
           date="2023-11-02T10:21:16.181Z")
@Stability(Stable)
public interface CfnLocationObjectStorageProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnLocationObjectStorage.

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.*;
 CfnLocationObjectStorageProps cfnLocationObjectStorageProps = CfnLocationObjectStorageProps.builder()
         .agentArns(List.of("agentArns"))
         // the properties below are optional
         .accessKey("accessKey")
         .bucketName("bucketName")
         .secretKey("secretKey")
         .serverCertificate("serverCertificate")
         .serverHostname("serverHostname")
         .serverPort(123)
         .serverProtocol("serverProtocol")
         .subdirectory("subdirectory")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnLocationObjectStorageProps.Builder	A builder for CfnLocationObjectStorageProps
static final class	CfnLocationObjectStorageProps.Jsii$Proxy	An implementation for CfnLocationObjectStorageProps

Method Summary

Modifier and Type	Method	Description
static CfnLocationObjectStorageProps.Builder	builder()
default String	getAccessKey()	Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
List<String>	getAgentArns()	Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.
default String	getBucketName()	Specifies the name of the object storage bucket involved in the transfer.
default String	getSecretKey()	Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
default String	getServerCertificate()	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 ).
default String	getServerHostname()	Specifies the domain name or IP address of the object storage server.
default Number	getServerPort()	Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
default String	getServerProtocol()	Specifies the protocol that your object storage server uses to communicate.
default String	getSubdirectory()	Specifies the object prefix for your object storage server.
default List<CfnTag>	getTags()	Specifies the key-value pair that represents a tag that you want to add to the resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAgentArns

@Stability(Stable)
@NotNull
List<String> getAgentArns()

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

See Also:

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

getAccessKey

@Stability(Stable)
@Nullable
default String getAccessKey()

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

See Also:

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

getBucketName

@Stability(Stable)
@Nullable
default String getBucketName()

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

See Also:

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

getSecretKey

@Stability(Stable)
@Nullable
default String getSecretKey()

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

See Also:

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

getServerCertificate

@Stability(Stable)
@Nullable
default String getServerCertificate()

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 .

See Also:

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

getServerHostname

@Stability(Stable)
@Nullable
default String getServerHostname()

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.

See Also:

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

getServerPort

@Stability(Stable)
@Nullable
default Number getServerPort()

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

See Also:

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

getServerProtocol

@Stability(Stable)
@Nullable
default String getServerProtocol()

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

See Also:

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

getSubdirectory

@Stability(Stable)
@Nullable
default String getSubdirectory()

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.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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.

See Also:

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

builder

@Stability(Stable)
static CfnLocationObjectStorageProps.Builder builder()

Returns:

a CfnLocationObjectStorageProps.Builder of CfnLocationObjectStorageProps