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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.891Z")
 @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() 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	getAttrLocationArn() The Amazon Resource Name (ARN) of the specified object storage location.
String	getAttrLocationUri() The URI of the specified object storage location.
String	getBucketName() Specifies the name of the bucket that DataSync reads from or writes to.
protected Map<String,Object>	getCfnProperties()
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.
Number	getServerPort() Specifies the port that your object storage server accepts inbound network traffic on.
String	getServerProtocol() Specifies the protocol that your object storage server uses to communicate.
String	getSubdirectory() Specifies the object prefix that DataSync reads from or writes to.
TagManager	getTags() Specifies the key-value pair that represents the tag to help you manage, filter, and search for your 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) Specifies the access key (or user name) if credentials are required to access the object storage server.
void	setAgentArns(List<String> value) Specifies the Amazon Resource Names (ARNs) of the agents associated with the location.
void	setBucketName(String value) Specifies the name of the bucket that DataSync reads from or writes to.
void	setSecretKey(String value) Specifies the secret key (or password) if credentials are required to access the object storage server.
void	setServerHostname(String value) Specifies the domain name or IP address of the object storage server.
void	setServerPort(Number value) Specifies the port that your object storage server accepts inbound network traffic on.
void	setServerProtocol(String value) Specifies the protocol that your object storage server uses to communicate.
void	setSubdirectory(String value) Specifies the object prefix that DataSync reads from or writes to.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, 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()

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.

getAgentArns

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

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

setAgentArns

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

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

getBucketName

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

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

setBucketName

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

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

getServerHostname

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

setServerHostname

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

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

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

setAccessKey

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

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

getSecretKey

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

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

setSecretKey

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

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

getServerPort

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

setServerPort

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

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

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

setServerProtocol

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

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

getSubdirectory

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

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

setSubdirectory

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

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