Package software.amazon.awscdk.services.iot.actions.alpha

Class S3PutObjectAction.Builder

java.lang.Object

software.amazon.awscdk.services.iot.actions.alpha.S3PutObjectAction.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<S3PutObjectAction>

Enclosing class:

S3PutObjectAction

@Stability(Experimental)
public static final class S3PutObjectAction.Builder
extends Object
implements software.amazon.jsii.Builder<S3PutObjectAction>

(experimental) A fluent builder for S3PutObjectAction.

Method Summary

Modifier and Type	Method	Description
S3PutObjectAction.Builder	accessControl(BucketAccessControl accessControl)	(experimental) The Amazon S3 canned ACL that controls access to the object identified by the object key.
S3PutObjectAction	build()
static S3PutObjectAction.Builder	create(IBucket bucket)
S3PutObjectAction.Builder	key(String key)	(experimental) The path to the file where the data is written.
S3PutObjectAction.Builder	role(IRole role)	(experimental) The IAM role that allows access to AWS service.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Experimental)
public static S3PutObjectAction.Builder create(IBucket bucket)

Parameters:

bucket - The Amazon S3 bucket to which to write data. This parameter is required.

Returns:

a new instance of S3PutObjectAction.Builder.

role

@Stability(Experimental)
public S3PutObjectAction.Builder role(IRole role)

(experimental) The IAM role that allows access to AWS service.

Default: a new role will be created

Parameters:

role - The IAM role that allows access to AWS service. This parameter is required.

Returns:

this

accessControl

@Stability(Experimental)
public S3PutObjectAction.Builder accessControl(BucketAccessControl accessControl)

(experimental) The Amazon S3 canned ACL that controls access to the object identified by the object key.

Default: None

Parameters:

accessControl - The Amazon S3 canned ACL that controls access to the object identified by the object key. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl

key

@Stability(Experimental)
public S3PutObjectAction.Builder key(String key)

(experimental) The path to the file where the data is written.

Supports substitution templates.

Default: '${topic()}/${timestamp()}'

Parameters:

key - The path to the file where the data is written. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html

build

@Stability(Experimental)
public S3PutObjectAction build()

Specified by:

build in interface software.amazon.jsii.Builder<S3PutObjectAction>

Returns:

a newly built instance of S3PutObjectAction.