Package software.amazon.awscdk.services.iot

Interface CfnTopicRule.S3ActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicRule.S3ActionProperty.Jsii$Proxy

Enclosing class:

CfnTopicRule

@Stability(Stable)
public static interface CfnTopicRule.S3ActionProperty
extends software.amazon.jsii.JsiiSerializable

Describes an action to write data to an Amazon S3 bucket.

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.iot.*;
 S3ActionProperty s3ActionProperty = S3ActionProperty.builder()
         .bucketName("bucketName")
         .key("key")
         .roleArn("roleArn")
         // the properties below are optional
         .cannedAcl("cannedAcl")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-s3action.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTopicRule.S3ActionProperty.Builder	builder()
String	getBucketName()	The Amazon S3 bucket.
default String	getCannedAcl()	The Amazon S3 canned ACL that controls access to the object identified by the object key.
String	getKey()	The object key.
String	getRoleArn()	The ARN of the IAM role that grants access.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucketName

@Stability(Stable)
@NotNull
String getBucketName()

The Amazon S3 bucket.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-s3action.html#cfn-iot-topicrule-s3action-bucketname

getKey

@Stability(Stable)
@NotNull
String getKey()

The object key.

For more information, see Actions, resources, and condition keys for Amazon S3 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-s3action.html#cfn-iot-topicrule-s3action-key

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The ARN of the IAM role that grants access.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-s3action.html#cfn-iot-topicrule-s3action-rolearn

getCannedAcl

@Stability(Stable)
@Nullable
default String getCannedAcl()

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

For more information, see S3 canned ACLs .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-s3action.html#cfn-iot-topicrule-s3action-cannedacl

builder

@Stability(Stable)
static CfnTopicRule.S3ActionProperty.Builder builder()

Returns:

a CfnTopicRule.S3ActionProperty.Builder of CfnTopicRule.S3ActionProperty