Package software.amazon.awscdk.services.datasync

Class CfnLocationS3

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.datasync.CfnLocationS3
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.205Z") @Stability(Stable) public class CfnLocationS3 extends CfnResource implements IInspectable
A CloudFormation AWS::DataSync::LocationS3.

The AWS::DataSync::LocationS3 resource specifies an endpoint for an Amazon S3 bucket.

For more information, see Create an Amazon S3 location in 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();

  • 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 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 -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      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.

    • 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

    • getTags

      @Stability(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.

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

      For detailed information about using such a role, see Creating a Location for Amazon S3 in the AWS DataSync User Guide .

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

      For detailed information about using such a role, see Creating a Location for Amazon S3 in the AWS DataSync User Guide .

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

      For detailed information about using such a role, see Creating a Location for Amazon S3 in the AWS DataSync User Guide .

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

      For buckets in AWS Regions , the storage class defaults to S3 Standard.

      For more information about S3 storage classes, see Amazon S3 Storage Classes . Some storage classes have behaviors that can affect your S3 storage costs. For detailed information, see Considerations When Working with Amazon S3 Storage Classes in DataSync .

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

      For buckets in AWS Regions , the storage class defaults to S3 Standard.

      For more information about S3 storage classes, see Amazon S3 Storage Classes . Some storage classes have behaviors that can affect your S3 storage costs. For detailed information, see Considerations When Working with Amazon S3 Storage Classes in DataSync .

    • getSubdirectory

      @Stability(Stable) @Nullable public String getSubdirectory()
      A subdirectory in the Amazon S3 bucket.

      This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.

    • setSubdirectory

      @Stability(Stable) public void setSubdirectory(@Nullable String value)
      A subdirectory in the Amazon S3 bucket.

      This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.