Package software.amazon.awscdk.services.kinesis

Class ResourcePolicy

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.kinesis.ResourcePolicy

All Implemented Interfaces:

IResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:10.025Z")
@Stability(Stable)
public class ResourcePolicy
extends Resource

The policy for a data stream or registered consumer.

Policies define the operations that are allowed on this resource.

You almost never need to define this construct directly.

All AWS resources that support resource policies have a method called addToResourcePolicy(), which will automatically create a new resource policy if one doesn't exist yet, otherwise it will add to the existing policy.

Prefer to use addToResourcePolicy() instead.

Example:

 Stream stream = new Stream(this, "MyStream");
 // create a custom policy document
 PolicyDocument policyDocument = PolicyDocument.Builder.create()
         .assignSids(true)
         .statements(List.of(
             PolicyStatement.Builder.create()
                     .actions(List.of("kinesis:GetRecords"))
                     .resources(List.of(stream.getStreamArn()))
                     .principals(List.of(new AnyPrincipal()))
                     .build()))
         .build();
 // create a resource policy manually
 // create a resource policy manually
 ResourcePolicy.Builder.create(this, "ResourcePolicy")
         .stream(stream)
         .policyDocument(policyDocument)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ResourcePolicy.Builder	A fluent builder for ResourcePolicy.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ResourcePolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ResourcePolicy(software.amazon.jsii.JsiiObjectRef objRef)
	ResourcePolicy(software.constructs.Construct scope, String id, ResourcePolicyProps props)

Method Summary

Modifier and Type	Method	Description
PolicyDocument	getDocument()	The IAM policy document for this policy.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

ResourcePolicy

protected ResourcePolicy(software.amazon.jsii.JsiiObjectRef objRef)

ResourcePolicy

protected ResourcePolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ResourcePolicy

@Stability(Stable)
public ResourcePolicy(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 ResourcePolicyProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

getDocument

@Stability(Stable)
@NotNull
public PolicyDocument getDocument()

The IAM policy document for this policy.