Package 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, ITaggable, ILocationObjectStorageRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:35.998Z") @Stability(Stable) public class CfnLocationObjectStorage extends CfnResource implements IInspectable, ILocationObjectStorageRef, 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")
         .accessKey("accessKey")
         .agentArns(List.of("agentArns"))
         .bucketName("bucketName")
         .cmkSecretConfig(CmkSecretConfigProperty.builder()
                 .kmsKeyArn("kmsKeyArn")
                 .secretArn("secretArn")
                 .build())
         .customSecretConfig(CustomSecretConfigProperty.builder()
                 .secretAccessRoleArn("secretAccessRoleArn")
                 .secretArn("secretArn")
                 .build())
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String 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, @Nullable 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.

    • CfnLocationObjectStorage

      @Stability(Stable) public CfnLocationObjectStorage(@NotNull software.constructs.Construct scope, @NotNull String id)
      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.

  • Method Details

    • inspect

      @Stability(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(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCmkSecretConfigSecretArn

      @Stability(Stable) @NotNull public String getAttrCmkSecretConfigSecretArn()
      Specifies the ARN for the DataSync-managed AWS Secrets Manager secret that that is used to access a specific storage location.

      This property is generated by DataSync and is read-only. DataSync encrypts this secret with the KMS key that you specify for KmsKeyArn .

    • getAttrLocationArn

      @Stability(Stable) @NotNull public String getAttrLocationArn()
      The Amazon Resource Name (ARN) of the specified object storage location.

    • getAttrLocationUri

      @Stability(Stable) @NotNull public String getAttrLocationUri()
      The URI of the specified object storage location.

    • getAttrManagedSecretConfig

      @Stability(Stable) @NotNull public IResolvable getAttrManagedSecretConfig()
      Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location.

      DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getLocationObjectStorageRef

      @Stability(Stable) @NotNull public LocationObjectStorageReference getLocationObjectStorageRef()
      A reference to a LocationObjectStorage resource.
      Specified by:
      getLocationObjectStorageRef in interface ILocationObjectStorageRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAccessKey

      @Stability(Stable) @Nullable public String getAccessKey()
      Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.

    • setAccessKey

      @Stability(Stable) public void setAccessKey(@Nullable String value)
      Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.

    • getAgentArns

      @Stability(Stable) @Nullable public List<String> getAgentArns()
      (Optional) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system.

    • setAgentArns

      @Stability(Stable) public void setAgentArns(@Nullable List<String> value)
      (Optional) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system.

    • getBucketName

      @Stability(Stable) @Nullable public String getBucketName()
      Specifies the name of the object storage bucket involved in the transfer.

    • setBucketName

      @Stability(Stable) public void setBucketName(@Nullable String value)
      Specifies the name of the object storage bucket involved in the transfer.

    • getCmkSecretConfig

      @Stability(Stable) @Nullable public Object getCmkSecretConfig()
      Specifies configuration information for a DataSync-managed secret, which includes the SecretKey that DataSync uses to access a specific object storage location, with a customer-managed AWS KMS key .

      Returns union: either IResolvable or CfnLocationObjectStorage.CmkSecretConfigProperty

    • setCmkSecretConfig

      @Stability(Stable) public void setCmkSecretConfig(@Nullable IResolvable value)
      Specifies configuration information for a DataSync-managed secret, which includes the SecretKey that DataSync uses to access a specific object storage location, with a customer-managed AWS KMS key .

    • setCmkSecretConfig

      @Stability(Stable) public void setCmkSecretConfig(@Nullable CfnLocationObjectStorage.CmkSecretConfigProperty value)
      Specifies configuration information for a DataSync-managed secret, which includes the SecretKey that DataSync uses to access a specific object storage location, with a customer-managed AWS KMS key .

    • getCustomSecretConfig

      @Stability(Stable) @Nullable public Object getCustomSecretConfig()
      Specifies configuration information for a customer-managed Secrets Manager secret where the secret key for a specific object storage location is stored in plain text.

      Returns union: either IResolvable or CfnLocationObjectStorage.CustomSecretConfigProperty

    • setCustomSecretConfig

      @Stability(Stable) public void setCustomSecretConfig(@Nullable IResolvable value)
      Specifies configuration information for a customer-managed Secrets Manager secret where the secret key for a specific object storage location is stored in plain text.

    • setCustomSecretConfig

      @Stability(Stable) public void setCustomSecretConfig(@Nullable CfnLocationObjectStorage.CustomSecretConfigProperty value)
      Specifies configuration information for a customer-managed Secrets Manager secret where the secret key for a specific object storage location is stored in plain text.

    • getSecretKey

      @Stability(Stable) @Nullable public String getSecretKey()
      Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.

    • setSecretKey

      @Stability(Stable) public void setSecretKey(@Nullable String value)
      Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.

    • getServerCertificate

      @Stability(Stable) @Nullable public String 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

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

    • getServerHostname

      @Stability(Stable) @Nullable public String getServerHostname()
      Specifies the domain name or IP address (IPv4 or IPv6) of the object storage server that your DataSync agent connects to.

    • setServerHostname

      @Stability(Stable) public void setServerHostname(@Nullable String value)
      Specifies the domain name or IP address (IPv4 or IPv6) of the object storage server that your DataSync agent connects to.

    • getServerPort

      @Stability(Stable) @Nullable public Number getServerPort()
      Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).

    • setServerPort

      @Stability(Stable) public void setServerPort(@Nullable Number value)
      Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).

    • getServerProtocol

      @Stability(Stable) @Nullable public String getServerProtocol()
      Specifies the protocol that your object storage server uses to communicate.

    • setServerProtocol

      @Stability(Stable) public void setServerProtocol(@Nullable String value)
      Specifies the protocol that your object storage server uses to communicate.

    • getSubdirectory

      @Stability(Stable) @Nullable public String getSubdirectory()
      Specifies the object prefix for your object storage server.

    • setSubdirectory

      @Stability(Stable) public void setSubdirectory(@Nullable String value)
      Specifies the object prefix for your object storage server.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Specifies the key-value pair that represents a tag that you want to add to the resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Specifies the key-value pair that represents a tag that you want to add to the resource.