interface ResourcePolicyProps

Language	Type name
.NET	Amazon.CDK.AWS.Kinesis.ResourcePolicyProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awskinesis#ResourcePolicyProps
Java	software.amazon.awscdk.services.kinesis.ResourcePolicyProps
Python	aws_cdk.aws_kinesis.ResourcePolicyProps
TypeScript (source)	aws-cdk-lib » aws_kinesis » ResourcePolicyProps

Properties to associate a data stream with a policy.

Example

const stream = new kinesis.Stream(this, 'MyStream');
const streamConsumer = new kinesis.StreamConsumer(this, 'MyStreamConsumer', {
  streamConsumerName: 'MyStreamConsumer',
  stream,
});

// create a custom policy document
const policyDocument = new iam.PolicyDocument({
  assignSids: true,
  statements: [
    new iam.PolicyStatement({
      actions: ['kinesis:GetRecords'],
      resources: [stream.streamArn],
      principals: [new iam.AnyPrincipal()],
    }),
  ],
});

// create a stream resource policy manually
new kinesis.ResourcePolicy(this, 'ResourcePolicy', {
  stream,
  policyDocument,
});

// create a stream consumer resource policy manually
new kinesis.ResourcePolicy(this, 'ResourcePolicy', {
  streamConsumer,
  policyDocument,
});

Properties

Name	Type	Description
policyDocument?	PolicyDocument	IAM policy document to apply to a data stream.
stream?	IStream	The stream this policy applies to.
streamConsumer?	IStreamConsumer	The stream consumer this policy applies to.

---

policyDocument?

Type: PolicyDocument (optional, default: empty policy document)

IAM policy document to apply to a data stream.

---

stream?

Type: IStream (optional, default: policy is not associated to a stream)

The stream this policy applies to.

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

---

streamConsumer?

Type: IStreamConsumer (optional, default: policy is not associated to a consumer)

The stream consumer this policy applies to.

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