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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.893Z")
 @Stability(value=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")
         .s3BucketArn("s3BucketArn")
         .s3Config(S3ConfigProperty.builder()
                 .bucketAccessRoleArn("bucketAccessRoleArn")
                 .build())
         // the properties below are optional
         .s3StorageClass("s3StorageClass")
         .subdirectory("subdirectory")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnLocationS3.Builder A fluent builder for CfnLocationS3.
static interface	CfnLocationS3.S3ConfigProperty The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role used to access an Amazon S3 bucket.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnLocationS3(software.constructs.Construct scope, String id, CfnLocationS3Props props) Create a new `AWS::DataSync::LocationS3`.
protected	CfnLocationS3(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnLocationS3(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrLocationArn() The Amazon Resource Name (ARN) of the specified Amazon S3 location.
String	getAttrLocationUri() The URI of the specified Amazon S3 location.
protected Map<String,Object>	getCfnProperties()
String	getS3BucketArn() The ARN of the Amazon S3 bucket.
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.
String	getS3StorageClass() The Amazon S3 storage class that you want to store your files in when this location is used as a task destination.
String	getSubdirectory() A subdirectory in the Amazon S3 bucket.
TagManager	getTags() The key-value pair that represents the tag that you want to add to the location.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setS3BucketArn(String value) The ARN of the Amazon S3 bucket.
void	setS3Config(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.
void	setS3Config(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.
void	setS3StorageClass(String value) The Amazon S3 storage class that you want to store your files in when this location is used as a task destination.
void	setSubdirectory(String value) A subdirectory in the Amazon S3 bucket.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnLocationS3

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

CfnLocationS3

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

CfnLocationS3

@Stability(value=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 - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrLocationArn()

The Amazon Resource Name (ARN) of the specified Amazon S3 location.

getAttrLocationUri

@Stability(value=Stable)
 @NotNull
public String getAttrLocationUri()

The URI of the specified Amazon S3 location.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

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

getS3BucketArn

@Stability(value=Stable)
 @NotNull
public String getS3BucketArn()

The ARN of the Amazon S3 bucket.

setS3BucketArn

@Stability(value=Stable)
public void setS3BucketArn(@NotNull
                                                    String value)

The ARN of the Amazon S3 bucket.

getS3Config

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

setS3Config

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

getS3StorageClass

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