AWS v6.60.0, Nov 19 24

AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.kinesis.ResourcePolicy

Explore with Pulumi AI

AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

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"]}"
  }}]
}}
""")

package main

import (
	"fmt"

	"github.com/pulumi/pulumi-aws/sdk/v6/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
	})
}

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 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.List;
import java.util.ArrayList;
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}"
          }]
        }

Create ResourcePolicy Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ResourcePolicy(name: string, args: ResourcePolicyArgs, opts?: CustomResourceOptions);

@overload
def ResourcePolicy(resource_name: str,
                   args: ResourcePolicyArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def ResourcePolicy(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   policy: Optional[str] = None,
                   resource_arn: Optional[str] = None)

func NewResourcePolicy(ctx *Context, name string, args ResourcePolicyArgs, opts ...ResourceOption) (*ResourcePolicy, error)

public ResourcePolicy(string name, ResourcePolicyArgs args, CustomResourceOptions? opts = null)

public ResourcePolicy(String name, ResourcePolicyArgs args)
public ResourcePolicy(String name, ResourcePolicyArgs args, CustomResourceOptions options)

type: aws:kinesis:ResourcePolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args ResourcePolicyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ResourcePolicyArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ResourcePolicyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ResourcePolicyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ResourcePolicyArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var exampleresourcePolicyResourceResourceFromKinesisresourcePolicy = new Aws.Kinesis.ResourcePolicy("exampleresourcePolicyResourceResourceFromKinesisresourcePolicy", new()
{
    Policy = "string",
    ResourceArn = "string",
});

example, err := kinesis.NewResourcePolicy(ctx, "exampleresourcePolicyResourceResourceFromKinesisresourcePolicy", &kinesis.ResourcePolicyArgs{
	Policy:      pulumi.String("string"),
	ResourceArn: pulumi.String("string"),
})

var exampleresourcePolicyResourceResourceFromKinesisresourcePolicy = new ResourcePolicy("exampleresourcePolicyResourceResourceFromKinesisresourcePolicy", ResourcePolicyArgs.builder()
    .policy("string")
    .resourceArn("string")
    .build());

exampleresource_policy_resource_resource_from_kinesisresource_policy = aws.kinesis.ResourcePolicy("exampleresourcePolicyResourceResourceFromKinesisresourcePolicy",
    policy="string",
    resource_arn="string")

const exampleresourcePolicyResourceResourceFromKinesisresourcePolicy = new aws.kinesis.ResourcePolicy("exampleresourcePolicyResourceResourceFromKinesisresourcePolicy", {
    policy: "string",
    resourceArn: "string",
});

type: aws:kinesis:ResourcePolicy
properties:
    policy: string
    resourceArn: string

ResourcePolicy Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ResourcePolicy resource accepts the following input properties:

Policy string: The policy document.
ResourceArn string: The Amazon Resource Name (ARN) of the data stream or consumer.

Policy string: The policy document.
ResourceArn string: The Amazon Resource Name (ARN) of the data stream or consumer.

policy String: The policy document.
resourceArn String: The Amazon Resource Name (ARN) of the data stream or consumer.

policy string: The policy document.
resourceArn string: The Amazon Resource Name (ARN) of the data stream or consumer.

policy str: The policy document.
resource_arn str: The Amazon Resource Name (ARN) of the data stream or consumer.

policy String: The policy document.
resourceArn String: The Amazon Resource Name (ARN) of the data stream or consumer.

Outputs

All input properties are implicitly available as output properties. Additionally, the ResourcePolicy resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing ResourcePolicy Resource

Get an existing ResourcePolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ResourcePolicyState, opts?: CustomResourceOptions): ResourcePolicy

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        policy: Optional[str] = None,
        resource_arn: Optional[str] = None) -> ResourcePolicy

func GetResourcePolicy(ctx *Context, name string, id IDInput, state *ResourcePolicyState, opts ...ResourceOption) (*ResourcePolicy, error)

public static ResourcePolicy Get(string name, Input<string> id, ResourcePolicyState? state, CustomResourceOptions? opts = null)

public static ResourcePolicy get(String name, Output<String> id, ResourcePolicyState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Policy string: The policy document.
ResourceArn string: The Amazon Resource Name (ARN) of the data stream or consumer.

Policy string: The policy document.
ResourceArn string: The Amazon Resource Name (ARN) of the data stream or consumer.

policy String: The policy document.
resourceArn String: The Amazon Resource Name (ARN) of the data stream or consumer.

policy string: The policy document.
resourceArn string: The Amazon Resource Name (ARN) of the data stream or consumer.

policy str: The policy document.
resource_arn str: The Amazon Resource Name (ARN) of the data stream or consumer.

policy String: The policy document.
resourceArn String: The Amazon Resource Name (ARN) of the data stream or consumer.

Import

Using pulumi import, import Kinesis resource policies using the resource_arn. For example:

$ pulumi import aws:kinesis/resourcePolicy:ResourcePolicy example arn:aws:kinesis:us-west-2:123456789012:stream/example

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

pulumi/pulumi-aws

aws.kinesis.ResourcePolicy

On this page

On this page

Example Usage

Create ResourcePolicy Resource

Constructor syntax

Parameters

Constructor example

ResourcePolicy Resource Properties

Inputs

Outputs

Look up Existing ResourcePolicy Resource

Import

Package Details

On this page

On this page