ResourcePolicy class
Provides a resource to manage an Amazon Kinesis Streams resource policy. Use a resource policy to manage cross-account access to your data streams or consumers.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.kinesis.ResourcePolicy("example", {
resourceArn: exampleAwsKinesisStream.arn,
policy: `{
\"Version\": \"2012-10-17\",
\"Id\": \"writePolicy\",
\"Statement\": [{
\"Sid\": \"writestatement\",
\"Effect\": \"Allow\",
\"Principal\": {
\"AWS\": \"123456789456\"
},
\"Action\": [
\"kinesis:DescribeStreamSummary\",
\"kinesis:ListShards\",
\"kinesis:PutRecord\",
\"kinesis:PutRecords\"
],
\"Resource\": \"${exampleAwsKinesisStream.arn}\"
}]
}
`,
});
import pulumi
import pulumi_aws as aws
example = aws.kinesis.ResourcePolicy("example",
resource_arn=example_aws_kinesis_stream["arn"],
policy=f"""{{
\"Version\": \"2012-10-17\",
\"Id\": \"writePolicy\",
\"Statement\": [{{
\"Sid\": \"writestatement\",
\"Effect\": \"Allow\",
\"Principal\": {{
\"AWS\": \"123456789456\"
}},
\"Action\": [
\"kinesis:DescribeStreamSummary\",
\"kinesis:ListShards\",
\"kinesis:PutRecord\",
\"kinesis:PutRecords\"
],
\"Resource\": \"{example_aws_kinesis_stream["arn"]}\"
}}]
}}
""")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Kinesis.ResourcePolicy("example", new()
{
ResourceArn = exampleAwsKinesisStream.Arn,
Policy = @$"{{
\""Version\"": \""2012-10-17\"",
\""Id\"": \""writePolicy\"",
\""Statement\"": [{{
\""Sid\"": \""writestatement\"",
\""Effect\"": \""Allow\"",
\""Principal\"": {{
\""AWS\"": \""123456789456\""
}},
\""Action\"": [
\""kinesis:DescribeStreamSummary\"",
\""kinesis:ListShards\"",
\""kinesis:PutRecord\"",
\""kinesis:PutRecords\""
],
\""Resource\"": \""{exampleAwsKinesisStream.Arn}\""
}}]
}}
",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/kinesis"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := kinesis.NewResourcePolicy(ctx, "example", &kinesis.ResourcePolicyArgs{
ResourceArn: pulumi.Any(exampleAwsKinesisStream.Arn),
Policy: pulumi.Sprintf(`{
\"Version\": \"2012-10-17\",
\"Id\": \"writePolicy\",
\"Statement\": [{
\"Sid\": \"writestatement\",
\"Effect\": \"Allow\",
\"Principal\": {
\"AWS\": \"123456789456\"
},
\"Action\": [
\"kinesis:DescribeStreamSummary\",
\"kinesis:ListShards\",
\"kinesis:PutRecord\",
\"kinesis:PutRecords\"
],
\"Resource\": \"%v\"
}]
}
`, exampleAwsKinesisStream.Arn),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_kinesis_resourcepolicy" "example" {
resource_arn = exampleAwsKinesisStream.arn
policy ="{
\"Version\": \"2012-10-17\",
\"Id\": \"writePolicy\",
\"Statement\": [{
\"Sid\": \"writestatement\",
\"Effect\": \"Allow\",
\"Principal\": {
\"AWS\": \"123456789456\"
},
\"Action\": [
\"kinesis:DescribeStreamSummary\",
\"kinesis:ListShards\",
\"kinesis:PutRecord\",
\"kinesis:PutRecords\"
],
\"Resource\": \"${exampleAwsKinesisStream.arn}\"
}]
}
"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.kinesis.ResourcePolicy;
import com.pulumi.aws.kinesis.ResourcePolicyArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new ResourcePolicy("example", ResourcePolicyArgs.builder()
.resourceArn(exampleAwsKinesisStream.arn())
.policy("""
{
\"Version\": \"2012-10-17\",
\"Id\": \"writePolicy\",
\"Statement\": [{
\"Sid\": \"writestatement\",
\"Effect\": \"Allow\",
\"Principal\": {
\"AWS\": \"123456789456\"
},
\"Action\": [
\"kinesis:DescribeStreamSummary\",
\"kinesis:ListShards\",
\"kinesis:PutRecord\",
\"kinesis:PutRecords\"
],
\"Resource\": \"%s\"
}]
}
", exampleAwsKinesisStream.arn()))
.build());
}
}
resources:
example:
type: aws:kinesis:ResourcePolicy
properties:
resourceArn: ${exampleAwsKinesisStream.arn}
policy: |
{
\"Version\": \"2012-10-17\",
\"Id\": \"writePolicy\",
\"Statement\": [{
\"Sid\": \"writestatement\",
\"Effect\": \"Allow\",
\"Principal\": {
\"AWS\": \"123456789456\"
},
\"Action\": [
\"kinesis:DescribeStreamSummary\",
\"kinesis:ListShards\",
\"kinesis:PutRecord\",
\"kinesis:PutRecords\"
],
\"Resource\": \"${exampleAwsKinesisStream.arn}\"
}]
}
Import
Identity Schema
Required
resourceArn(String) ARN of the Kinesis stream.
Using pulumi import, import Kinesis resource policies using the resourceArn. For example:
$ pulumi import aws:kinesis/resourcePolicy:ResourcePolicy example arn:aws:kinesis:us-west-2:123456789012:stream/example
Constructors
- ResourcePolicy(String name, {ResourcePolicyArgs? args, CustomResourceOptions? options})
-
Creates a new ResourcePolicy.
nameThe Pulumi resource name.argsArguments used to configure this ResourcePolicy. The set of arguments for ResourcePolicy.optionsResource options controlling this resource's behavior. - ResourcePolicy.reference(String urn)
- Creates a typed reference to an existing ResourcePolicy resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
policy
↔ Output<
String> -
The policy document.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceArn
↔ Output<
String> -
ARN of the data stream or consumer.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {ResourcePolicyState? state, CustomResourceOptions? options}) → ResourcePolicy -
Gets an existing ResourcePolicy resource's state with the given
nameandid.