software.amazon.awscdk.services.datasync

Class CfnLocationObjectStorage

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.datasync.CfnLocationObjectStorage

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.57.0 (build f614666)",
           date="2022-04-22T09:30:46.478Z")
 @Stability(value=Stable)
public class CfnLocationObjectStorage
extends CfnResource
implements IInspectable

A CloudFormation `AWS::DataSync::LocationObjectStorage`.

The AWS::DataSync::LocationObjectStorage resource specifies an endpoint for a self-managed object storage bucket. For more information about self-managed object storage locations, see Creating a Location for Object Storage .

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.*;
 CfnLocationObjectStorage cfnLocationObjectStorage = CfnLocationObjectStorage.Builder.create(this, "MyCfnLocationObjectStorage")
         .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	Class and Description
static class	CfnLocationObjectStorage.Builder A fluent builder for CfnLocationObjectStorage.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnLocationObjectStorage(software.constructs.Construct scope, String id, CfnLocationObjectStorageProps props) Create a new `AWS::DataSync::LocationObjectStorage`.
protected	CfnLocationObjectStorage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnLocationObjectStorage(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAccessKey() Optional.
List<String>	getAgentArns() The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.
String	getAttrLocationArn() The Amazon Resource Name (ARN) of the specified object storage location.
String	getAttrLocationUri() The URI of the specified object storage location.
String	getBucketName() The bucket on the self-managed object storage server that is used to read data from.
protected Map<String,Object>	getCfnProperties()
String	getSecretKey() Optional.
String	getServerHostname() The name of the self-managed object storage server.
Number	getServerPort() The port that your self-managed object storage server accepts inbound network traffic on.
String	getServerProtocol() The protocol that the object storage server uses to communicate.
String	getSubdirectory() The subdirectory in the self-managed object storage server that is used to read data from.
TagManager	getTags() The key-value pair that represents the tag that you want to add to the location.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccessKey(String value) Optional.
void	setAgentArns(List<String> value) The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.
void	setBucketName(String value) The bucket on the self-managed object storage server that is used to read data from.
void	setSecretKey(String value) Optional.
void	setServerHostname(String value) The name of the self-managed object storage server.
void	setServerPort(Number value) The port that your self-managed object storage server accepts inbound network traffic on.
void	setServerProtocol(String value) The protocol that the object storage server uses to communicate.
void	setSubdirectory(String value) The subdirectory in the self-managed object storage server that is used to read data from.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnLocationObjectStorage

protected CfnLocationObjectStorage(software.amazon.jsii.JsiiObjectRef objRef)

CfnLocationObjectStorage

protected CfnLocationObjectStorage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnLocationObjectStorage

@Stability(value=Stable)
public CfnLocationObjectStorage(@NotNull
                                                         software.constructs.Construct scope,
                                                         @NotNull
                                                         String id,
                                                         @NotNull
                                                         CfnLocationObjectStorageProps props)

Create a new `AWS::DataSync::LocationObjectStorage`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrLocationArn

@Stability(value=Stable)
 @NotNull
public String getAttrLocationArn()

The Amazon Resource Name (ARN) of the specified object storage location.

getAttrLocationUri

@Stability(value=Stable)
 @NotNull
public String getAttrLocationUri()

The URI of the specified object storage location.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

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

getAgentArns

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

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

setAgentArns

@Stability(value=Stable)
public void setAgentArns(@NotNull
                                                  List<String> value)

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

getBucketName

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

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

setBucketName

@Stability(value=Stable)
public void setBucketName(@NotNull
                                                   String value)

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

getServerHostname

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

setServerHostname

@Stability(value=Stable)
public void setServerHostname(@NotNull
                                                       String value)

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
public 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.

setAccessKey

@Stability(value=Stable)
public void setAccessKey(@Nullable
                                                  String value)

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
public 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.

setSecretKey

@Stability(value=Stable)
public void setSecretKey(@Nullable
                                                  String value)

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
public 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.

setServerPort

@Stability(value=Stable)
public void setServerPort(@Nullable
                                                   Number value)

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
public String getServerProtocol()

The protocol that the object storage server uses to communicate.

Valid values are HTTP or HTTPS.

setServerProtocol

@Stability(value=Stable)
public void setServerProtocol(@Nullable
                                                       String value)

The protocol that the object storage server uses to communicate.

Valid values are HTTP or HTTPS.

getSubdirectory

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

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

setSubdirectory

@Stability(value=Stable)
public void setSubdirectory(@Nullable
                                                     String value)

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