Interface CfnLocationS3Props
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnLocationS3Props.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-08-23T05:56:14.377Z")
@Stability(Stable)
public interface CfnLocationS3Props
extends software.amazon.jsii.JsiiSerializable
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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnLocationS3Props
static final class
An implementation forCfnLocationS3Props
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnLocationS3Props.Builder
builder()
default String
The ARN of the Amazon S3 bucket.The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket.default String
The Amazon S3 storage class that you want to store your files in when this location is used as a task destination.default String
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).getTags()
Specifies labels that help you categorize, filter, and search for your AWS resources.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
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 .
- See Also:
-
getS3BucketArn
The ARN of the Amazon S3 bucket.- See Also:
-
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 .
Default: - "STANDARD"
- See Also:
-
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).DataSync can't transfer objects with a prefix that begins with a slash (
/
) or includes//
,/./
, or/../
patterns. For example:/photos
photos//2006/January
photos/./2006/February
photos/../2006/March
- See Also:
-
getTags
Specifies labels that help you categorize, filter, and search for your AWS resources.We recommend creating at least a name tag for your transfer location.
- See Also:
-
builder
- Returns:
- a
CfnLocationS3Props.Builder
ofCfnLocationS3Props
-