Package software.amazon.awscdk.services.iotsitewise

Interface CfnTask.S3AccessPointSourceProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTask.S3AccessPointSourceProperty.Jsii$Proxy

Enclosing class:

CfnTask

@Stability(Stable)
public static interface CfnTask.S3AccessPointSourceProperty
extends software.amazon.jsii.JsiiSerializable

Configures a mount that reads from an Amazon S3 access point.

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.iotsitewise.*;
 S3AccessPointSourceProperty s3AccessPointSourceProperty = S3AccessPointSourceProperty.builder()
         .accessPointArn("accessPointArn")
         // the properties below are optional
         .prefix("prefix")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-task-s3accesspointsource.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTask.S3AccessPointSourceProperty.Builder	builder()
String	getAccessPointArn()	The Amazon Resource Name (ARN) of the Amazon S3 access point.
default String	getPrefix()	An object key name prefix.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccessPointArn

@Stability(Stable)
@NotNull
String getAccessPointArn()

The Amazon Resource Name (ARN) of the Amazon S3 access point.

The mount reads objects from the bucket associated with this access point. Access is governed by the access point policy and the task execution role's IAM permissions.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-task-s3accesspointsource.html#cfn-iotsitewise-task-s3accesspointsource-accesspointarn

getPrefix

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

An object key name prefix.

If specified, the mount includes only objects whose keys begin with this prefix. To include all objects at the access point, omit this field.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-task-s3accesspointsource.html#cfn-iotsitewise-task-s3accesspointsource-prefix

builder

@Stability(Stable)
static CfnTask.S3AccessPointSourceProperty.Builder builder()

Returns:

a CfnTask.S3AccessPointSourceProperty.Builder of CfnTask.S3AccessPointSourceProperty