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

Interface S3PutObjectActionProps

All Superinterfaces:

CommonActionProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

S3PutObjectActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-24T02:42:46.886Z")
@Stability(Experimental)
public interface S3PutObjectActionProps
extends software.amazon.jsii.JsiiSerializable, CommonActionProps

(experimental) Configuration properties of an action for s3.

Example:

 Bucket bucket = new Bucket(this, "MyBucket");
 TopicRule.Builder.create(this, "TopicRule")
         .sql(IotSql.fromStringAsVer20160323("SELECT topic(2) as device_id, year, month, day FROM 'device/+/data'"))
         .actions(List.of(
             S3PutObjectAction.Builder.create(bucket)
                     .key("${year}/${month}/${day}/${topic(2)}")
                     .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static S3PutObjectActionProps.Builder	builder()
default BucketAccessControl	getAccessControl()	(experimental) The Amazon S3 canned ACL that controls access to the object identified by the object key.
default String	getKey()	(experimental) The path to the file where the data is written.

Methods inherited from interface software.amazon.awscdk.services.iot.actions.alpha.CommonActionProps

getRole

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccessControl

@Stability(Experimental)
@Nullable
default BucketAccessControl getAccessControl()

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

Default: None

See Also:

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

getKey

@Stability(Experimental)
@Nullable
default String getKey()

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

Supports substitution templates.

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

See Also:

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

builder

@Stability(Experimental)
static S3PutObjectActionProps.Builder builder()

Returns:

a S3PutObjectActionProps.Builder of S3PutObjectActionProps