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.58.0 (build f8ba112)",
           date="2022-05-11T19:24:27.659Z")
 @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() Optional.
List<String>	getAgentArns() The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.
String	getBucketName() The bucket on the self-managed object storage server that is used to read data from.
default String	getSecretKey() Optional.
String	getServerHostname() The name of the self-managed object storage server.
default Number	getServerPort() The port that your self-managed object storage server accepts inbound network traffic on.
default String	getServerProtocol() The protocol that the object storage server uses to communicate.
default String	getSubdirectory() The subdirectory in the self-managed object storage server that is used to read data from.
default List<CfnTag>	getTags() The key-value pair that represents the tag that you want to add to the location.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAgentArns

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

The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.

getBucketName

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

The bucket on the self-managed object storage server that is used to read data from.

getServerHostname

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

The name of the self-managed object storage server.

This value is the IP address or Domain Name Service (DNS) name of the object storage server. An agent uses this hostname to mount the object storage server in a network.

getAccessKey

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

Optional.

The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.

getSecretKey

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

Optional.

The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.

getServerPort

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

The port that your self-managed object storage server accepts inbound network traffic on.

The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.

getServerProtocol

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

The protocol that the object storage server uses to communicate.

Valid values are HTTP or HTTPS.

getSubdirectory

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

The subdirectory in the self-managed object storage server that is used to read data from.

getTags

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

The key-value pair that represents the tag that you want to add to the location.

The value can be an empty string. We recommend using tags to name your resources.

builder

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

Returns:

a CfnLocationObjectStorageProps.Builder of CfnLocationObjectStorageProps