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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.892Z")
 @Stability(value=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"))
         .bucketName("bucketName")
         .serverHostname("serverHostname")
         // the properties below are optional
         .accessKey("accessKey")
         .secretKey("secretKey")
         .serverPort(123)
         .serverProtocol("serverProtocol")
         .subdirectory("subdirectory")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnLocationObjectStorageProps.Builder	builder()
default String	getAccessKey() Specifies the access key (or user name) if credentials are required to access the object storage server.
List<String>	getAgentArns() Specifies the Amazon Resource Names (ARNs) of the agents associated with the location.
String	getBucketName() Specifies the name of the bucket that DataSync reads from or writes to.
default String	getSecretKey() Specifies the secret key (or password) if credentials are required to access the object storage server.
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.
default String	getServerProtocol() Specifies the protocol that your object storage server uses to communicate.
default String	getSubdirectory() Specifies the object prefix that DataSync reads from or writes to.
default List<CfnTag>	getTags() Specifies the key-value pair that represents the tag to help you manage, filter, and search for your location.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAgentArns

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

Specifies the Amazon Resource Names (ARNs) of the agents associated with the location.

getBucketName

@Stability(value=Stable)
 @NotNull
String getBucketName()

Specifies the name of the bucket that DataSync reads from or writes to.

getServerHostname

@Stability(value=Stable)
 @NotNull
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.

getAccessKey

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

Specifies the access key (or user name) if credentials are required to access the object storage server.

getSecretKey

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

Specifies the secret key (or password) if credentials are required to access the object storage server.

getServerPort

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

Specifies the port that your object storage server accepts inbound network traffic on.

Set to port 80 (HTTP), 443 (HTTPS), or a custom port if needed.

getServerProtocol

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

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

getSubdirectory

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

Specifies the object prefix that DataSync reads from or writes to.

getTags

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

Specifies the key-value pair that represents the tag to help you manage, filter, and search for your location.

We recommend using tags for naming your locations.

builder

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

Returns:

a CfnLocationObjectStorageProps.Builder of CfnLocationObjectStorageProps