software.amazon.awscdk.services.datasync

Interface CfnLocationS3Props

All Known Implementing Classes:

CfnLocationS3Props.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.773Z")
public interface CfnLocationS3Props

Properties for defining a `CfnLocationS3`.

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.*;
 CfnLocationS3Props cfnLocationS3Props = CfnLocationS3Props.builder()
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnLocationS3Props.Builder A builder for CfnLocationS3Props
static class	CfnLocationS3Props.Jsii$Proxy An implementation for CfnLocationS3Props

Method Summary

Modifier and Type	Method and Description
static CfnLocationS3Props.Builder	builder()
default java.lang.String	getS3BucketArn() The ARN of the Amazon S3 bucket.
java.lang.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.
default java.lang.String	getS3StorageClass() The Amazon S3 storage class that you want to store your files in when this location is used as a task destination.
default java.lang.String	getSubdirectory() A subdirectory in the Amazon S3 bucket.
default java.util.List<CfnTag>	getTags() The key-value pair that represents the tag that you want to add to the location.

Method Detail

getS3Config

java.lang.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 .

getS3BucketArn

default java.lang.String getS3BucketArn()

The ARN of the Amazon S3 bucket.

getS3StorageClass

default java.lang.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 .

getSubdirectory

default java.lang.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.

getTags

default java.util.List<CfnTag> 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.

builder

static CfnLocationS3Props.Builder builder()

Returns:

a CfnLocationS3Props.Builder of CfnLocationS3Props