Package software.amazon.awscdk.services.kinesis

Class ResourcePolicy.Builder

java.lang.Object

software.amazon.awscdk.services.kinesis.ResourcePolicy.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ResourcePolicy>

Enclosing class:

ResourcePolicy

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

A fluent builder for ResourcePolicy.

Method Summary

Modifier and Type	Method	Description
ResourcePolicy	build()
static ResourcePolicy.Builder	create(software.constructs.Construct scope, String id)
ResourcePolicy.Builder	policyDocument(PolicyDocument policyDocument)	IAM policy document to apply to a data stream.
ResourcePolicy.Builder	stream(IStream stream)	The stream this policy applies to.
ResourcePolicy.Builder	streamConsumer(IStreamConsumer streamConsumer)	The stream consumer this policy applies to.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static ResourcePolicy.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of ResourcePolicy.Builder.

policyDocument

@Stability(Stable)
public ResourcePolicy.Builder policyDocument(PolicyDocument policyDocument)

IAM policy document to apply to a data stream.

Default: - empty policy document

Parameters:

policyDocument - IAM policy document to apply to a data stream. This parameter is required.

Returns:

this

stream

@Stability(Stable)
public ResourcePolicy.Builder stream(IStream stream)

The stream this policy applies to.

Note: only one of stream and streamConsumer must be set.

Default: - policy is not associated to a stream

Parameters:

stream - The stream this policy applies to. This parameter is required.

Returns:

this

streamConsumer

@Stability(Stable)
public ResourcePolicy.Builder streamConsumer(IStreamConsumer streamConsumer)

The stream consumer this policy applies to.

Note: only one of stream and streamConsumer must be set.

Default: - policy is not associated to a consumer

Parameters:

streamConsumer - The stream consumer this policy applies to. This parameter is required.

Returns:

this

build

@Stability(Stable)
public ResourcePolicy build()

Specified by:

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

Returns:

a newly built instance of ResourcePolicy.