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
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-22T02:23:59.616Z")
@Stability(Stable)
public class CfnLocationObjectStorage
extends CfnResource
implements IInspectable, ITaggable
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")) // 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();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnLocationObjectStorage
.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnLocationObjectStorage
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnLocationObjectStorage
(software.amazon.jsii.JsiiObjectRef objRef) CfnLocationObjectStorage
(software.constructs.Construct scope, String id, CfnLocationObjectStorageProps props) -
Method Summary
Modifier and TypeMethodDescriptionSpecifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system.The Amazon Resource Name (ARN) of the specified object storage location.The URI of the specified object storage location.Specifies the name of the object storage bucket involved in the transfer.Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.Specifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA).Specifies the domain name or IP address of the object storage server.Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).Specifies the protocol that your object storage server uses to communicate.Specifies the object prefix for your object storage server.getTags()
Tag Manager which manages the tags for this resource.Specifies the key-value pair that represents a tag that you want to add to the resource.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setAccessKey
(String value) Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.void
setAgentArns
(List<String> value) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system.void
setBucketName
(String value) Specifies the name of the object storage bucket involved in the transfer.void
setSecretKey
(String value) Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.void
setServerCertificate
(String value) Specifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA).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 (for example, port 443).void
setServerProtocol
(String value) Specifies the protocol that your object storage server uses to communicate.void
setSubdirectory
(String value) Specifies the object prefix for your object storage server.void
setTagsRaw
(List<CfnTag> value) Specifies the key-value pair that represents a tag that you want to add to the resource.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnLocationObjectStorage
protected CfnLocationObjectStorage(software.amazon.jsii.JsiiObjectRef objRef) -
CfnLocationObjectStorage
protected CfnLocationObjectStorage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnLocationObjectStorage
@Stability(Stable) public CfnLocationObjectStorage(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnLocationObjectStorageProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrLocationArn
The Amazon Resource Name (ARN) of the specified object storage location. -
getAttrLocationUri
The URI of the specified object storage location. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getAgentArns
Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system. -
setAgentArns
Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system. -
getAccessKey
Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server. -
setAccessKey
Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server. -
getBucketName
Specifies the name of the object storage bucket involved in the transfer. -
setBucketName
Specifies the name of the object storage bucket involved in the transfer. -
getSecretKey
Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server. -
setSecretKey
Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server. -
getServerCertificate
Specifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA). -
setServerCertificate
Specifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA). -
getServerHostname
Specifies the domain name or IP address of the object storage server. -
setServerHostname
Specifies the domain name or IP address of the object storage server. -
getServerPort
Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443). -
setServerPort
Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443). -
getServerProtocol
Specifies the protocol that your object storage server uses to communicate. -
setServerProtocol
Specifies the protocol that your object storage server uses to communicate. -
getSubdirectory
Specifies the object prefix for your object storage server. -
setSubdirectory
Specifies the object prefix for your object storage server. -
getTagsRaw
Specifies the key-value pair that represents a tag that you want to add to the resource. -
setTagsRaw
Specifies the key-value pair that represents a tag that you want to add to the resource.
-