CfnLocationObjectStorageProps

All Known Implementing Classes:: CfnLocationObjectStorageProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:14.879Z")
public interface CfnLocationObjectStorageProps

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();

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

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

- Method Detail
  - getAgentArns
```
java.util.List<java.lang.String> getAgentArns()
```
    Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.
  - getAccessKey
```
default java.lang.String getAccessKey()
```
    Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
  - getBucketName
```
default java.lang.String getBucketName()
```
    Specifies the name of the object storage bucket involved in the transfer.
  - getSecretKey
```
default java.lang.String getSecretKey()
```
    Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
  - getServerCertificate
```
default java.lang.String getServerCertificate()
```
    Specifies a certificate to authenticate with an object storage system that uses a private or self-signed certificate authority (CA).
    You must specify a Base64-encoded .pem file (for example, file:///home/user/.ssh/storage_sys_certificate.pem ). The certificate can be up to 32768 bytes (before Base64 encoding).
    To use this parameter, configure ServerProtocol to HTTPS .
  - getServerHostname
```
default java.lang.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.
  - getServerPort
```
default java.lang.Number getServerPort()
```
    Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
  - getServerProtocol
```
default java.lang.String getServerProtocol()
```
    Specifies the protocol that your object storage server uses to communicate.
  - getSubdirectory
```
default java.lang.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.
  - getTags
```
default java.util.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.
  - builder
```
static CfnLocationObjectStorageProps.Builder builder()
```
    Returns:
    
    a CfnLocationObjectStorageProps.Builder of CfnLocationObjectStorageProps

Interface CfnLocationObjectStorageProps

Nested Class Summary

Method Summary

Method Detail

getAgentArns

getAccessKey

getBucketName

getSecretKey

getServerCertificate

getServerHostname

getServerPort

getServerProtocol

getSubdirectory

getTags

builder