Package software.amazon.awscdk.services.datasync

Class CfnLocationS3

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.CfnLocationS3
All Implemented Interfaces:
IInspectable, ILocationS3Ref, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:17.997Z") @Stability(Stable) public class CfnLocationS3 extends CfnResource implements IInspectable, ILocationS3Ref, ITaggable
The AWS::DataSync::LocationS3 resource specifies an endpoint for an Amazon S3 bucket.

For more information, see the AWS DataSync User Guide .

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.*;
 CfnLocationS3 cfnLocationS3 = CfnLocationS3.Builder.create(this, "MyCfnLocationS3")
         .s3Config(S3ConfigProperty.builder()
                 .bucketAccessRoleArn("bucketAccessRoleArn")
                 .build())
         // the properties below are optional
         .s3BucketArn("s3BucketArn")
         .s3StorageClass("s3StorageClass")
         .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

    • CfnLocationS3

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

    • CfnLocationS3

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

    • CfnLocationS3

      @Stability(Stable) public CfnLocationS3(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnLocationS3Props props)
      Create a new AWS::DataSync::LocationS3.

      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

    • isCfnLocationS3

      @Stability(Stable) @NotNull public static Boolean isCfnLocationS3(@NotNull Object x)
      Checks whether the given object is a CfnLocationS3.

      Parameters:
      x - This parameter is required.

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

    • getAttrLocationArn

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

    • getAttrLocationUri

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

    • getCfnProperties

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

    • getLocationS3Ref

      @Stability(Stable) @NotNull public LocationS3Reference getLocationS3Ref()
      A reference to a LocationS3 resource.
      Specified by:
      getLocationS3Ref in interface ILocationS3Ref

    • getTags

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

    • getS3Config

      @Stability(Stable) @NotNull public Object getS3Config()
      The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket.

      Returns union: either IResolvable or CfnLocationS3.S3ConfigProperty

    • setS3Config

      @Stability(Stable) public void setS3Config(@NotNull IResolvable value)
      The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket.

    • setS3Config

      @Stability(Stable) public void setS3Config(@NotNull CfnLocationS3.S3ConfigProperty value)
      The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket.

    • getS3BucketArn

      @Stability(Stable) @Nullable public String getS3BucketArn()
      The ARN of the Amazon S3 bucket.

    • setS3BucketArn

      @Stability(Stable) public void setS3BucketArn(@Nullable String value)
      The ARN of the Amazon S3 bucket.

    • getS3StorageClass

      @Stability(Stable) @Nullable public String getS3StorageClass()
      The Amazon S3 storage class that you want to store your files in when this location is used as a task destination.

    • setS3StorageClass

      @Stability(Stable) public void setS3StorageClass(@Nullable String value)
      The Amazon S3 storage class that you want to store your files in when this location is used as a task destination.

    • getSubdirectory

      @Stability(Stable) @Nullable public String getSubdirectory()
      Specifies a prefix in the S3 bucket that DataSync reads from or writes to (depending on whether the bucket is a source or destination location).

    • setSubdirectory

      @Stability(Stable) public void setSubdirectory(@Nullable String value)
      Specifies a prefix in the S3 bucket that DataSync reads from or writes to (depending on whether the bucket is a source or destination location).

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Specifies labels that help you categorize, filter, and search for your AWS resources.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Specifies labels that help you categorize, filter, and search for your AWS resources.