ClusterPolicy class

Resource for managing an AWS Managed Streaming for Kafka Cluster Policy.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const current = aws.getCallerIdentity({});
const currentGetPartition = aws.getPartition({});
const example = new aws.msk.ClusterPolicy("example", {
    clusterArn: exampleAwsMskCluster.arn,
    policy: JSON.stringify({
        Version: "2012-10-17",
        Statement: [{
            Sid: "ExampleMskClusterPolicy",
            Effect: "Allow",
            Principal: {
                AWS: Promise.all([currentGetPartition, current]).then(([currentGetPartition, current]) => `arn:${currentGetPartition.partition}:iam::${current.accountId}:root`),
            },
            Action: [
                "kafka:Describe*",
                "kafka:Get*",
                "kafka:CreateVpcConnection",
                "kafka:GetBootstrapBrokers",
            ],
            Resource: exampleAwsMskCluster.arn,
        }],
    }),
});
import pulumi
import json
import pulumi_aws as aws

current = aws.get_caller_identity()
current_get_partition = aws.get_partition()
example = aws.msk.ClusterPolicy("example",
    cluster_arn=example_aws_msk_cluster["arn"],
    policy=json.dumps({
        "Version": "2012-10-17",
        "Statement": [{
            "Sid": "ExampleMskClusterPolicy",
            "Effect": "Allow",
            "Principal": {
                "AWS": f"arn:{current_get_partition.partition}:iam::{current.account_id}:root",
            },
            "Action": [
                "kafka:Describe*",
                "kafka:Get*",
                "kafka:CreateVpcConnection",
                "kafka:GetBootstrapBrokers",
            ],
            "Resource": example_aws_msk_cluster["arn"],
        }],
    }))
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var current = Aws.GetCallerIdentity.Invoke();

    var currentGetPartition = Aws.GetPartition.Invoke();

    var example = new Aws.Msk.ClusterPolicy("example", new()
    {
        ClusterArn = exampleAwsMskCluster.Arn,
        Policy = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["Version"] = "2012-10-17",
            ["Statement"] = new[]
            {
                new Dictionary<string, object?>
                {
                    ["Sid"] = "ExampleMskClusterPolicy",
                    ["Effect"] = "Allow",
                    ["Principal"] = new Dictionary<string, object?>
                    {
                        ["AWS"] = Output.Tuple(currentGetPartition, current).Apply(values =>
                        {
                            var currentGetPartition = values.Item1;
                            var current = values.Item2;
                            return $"arn:{currentGetPartition.Apply(getPartitionResult => getPartitionResult.Partition)}:iam::{current.Apply(getCallerIdentityResult => getCallerIdentityResult.AccountId)}:root";
                        }),
                    },
                    ["Action"] = new[]
                    {
                        "kafka:Describe*",
                        "kafka:Get*",
                        "kafka:CreateVpcConnection",
                        "kafka:GetBootstrapBrokers",
                    },
                    ["Resource"] = exampleAwsMskCluster.Arn,
                },
            },
        }),
    });

});
package main

import (
	"encoding/json"
	"fmt"

	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws"
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/msk"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		current, err := aws.GetCallerIdentity(ctx, &aws.GetCallerIdentityArgs{}, nil)
		if err != nil {
			return err
		}
		currentGetPartition, err := aws.GetPartition(ctx, &aws.GetPartitionArgs{}, nil)
		if err != nil {
			return err
		}
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"Version": "2012-10-17",
			"Statement": []map[string]interface{}{
				map[string]interface{}{
					"Sid":    "ExampleMskClusterPolicy",
					"Effect": "Allow",
					"Principal": map[string]string{
						"AWS": fmt.Sprintf("arn:%v:iam::%v:root", currentGetPartition.Partition, current.AccountId),
					},
					"Action": []string{
						"kafka:Describe*",
						"kafka:Get*",
						"kafka:CreateVpcConnection",
						"kafka:GetBootstrapBrokers",
					},
					"Resource": exampleAwsMskCluster.Arn,
				},
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = msk.NewClusterPolicy(ctx, "example", &msk.ClusterPolicyArgs{
			ClusterArn: pulumi.Any(exampleAwsMskCluster.Arn),
			Policy:     json0,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_getcalleridentity" "current" {
}
data "aws_getpartition" "currentGetPartition" {
}

resource "aws_msk_clusterpolicy" "example" {
  cluster_arn = exampleAwsMskCluster.arn
  policy = jsonencode({
    "Version" = "2012-10-17"
    "Statement" = [{
      "Sid"    = "ExampleMskClusterPolicy"
      "Effect" = "Allow"
      "Principal" = {
        "AWS" ="arn:${data.aws_getpartition.currentGetPartition.partition}:iam::${data.aws_getcalleridentity.current.account_id}:root"
      }
      "Action"   = ["kafka:Describe*", "kafka:Get*", "kafka:CreateVpcConnection", "kafka:GetBootstrapBrokers"]
      "Resource" = exampleAwsMskCluster.arn
    }]
  })
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.AwsFunctions;
import com.pulumi.aws.inputs.GetCallerIdentityArgs;
import com.pulumi.aws.inputs.GetPartitionArgs;
import com.pulumi.aws.msk.ClusterPolicy;
import com.pulumi.aws.msk.ClusterPolicyArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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) {
        final var current = AwsFunctions.getCallerIdentity(GetCallerIdentityArgs.builder()
            .build());

        final var currentGetPartition = AwsFunctions.getPartition(GetPartitionArgs.builder()
            .build());

        var example = new ClusterPolicy("example", ClusterPolicyArgs.builder()
            .clusterArn(exampleAwsMskCluster.arn())
            .policy(serializeJson(
                jsonObject(
                    jsonProperty("Version", "2012-10-17"),
                    jsonProperty("Statement", jsonArray(jsonObject(
                        jsonProperty("Sid", "ExampleMskClusterPolicy"),
                        jsonProperty("Effect", "Allow"),
                        jsonProperty("Principal", jsonObject(
                            jsonProperty("AWS", String.format("arn:%s:iam::%s:root", currentGetPartition.partition(),current.accountId()))
                        )),
                        jsonProperty("Action", jsonArray(
                            "kafka:Describe*",
                            "kafka:Get*",
                            "kafka:CreateVpcConnection",
                            "kafka:GetBootstrapBrokers"
                        )),
                        jsonProperty("Resource", exampleAwsMskCluster.arn())
                    )))
                )))
            .build());

    }
}
resources:
  example:
    type: aws:msk:ClusterPolicy
    properties:
      clusterArn: ${exampleAwsMskCluster.arn}
      policy:
        fn::toJSON:
          Version: 2012-10-17
          Statement:
            - Sid: ExampleMskClusterPolicy
              Effect: Allow
              Principal:
                AWS: arn:${currentGetPartition.partition}:iam::${current.accountId}:root
              Action:
                - kafka:Describe*
                - kafka:Get*
                - kafka:CreateVpcConnection
                - kafka:GetBootstrapBrokers
              Resource: ${exampleAwsMskCluster.arn}
variables:
  current:
    fn::invoke:
      function: aws:getCallerIdentity
      arguments: {}
  currentGetPartition:
    fn::invoke:
      function: aws:getPartition
      arguments: {}

Import

Using pulumi import, import Managed Streaming for Kafka Cluster Policy using the clusterArn. For example:

$ pulumi import aws:msk/clusterPolicy:ClusterPolicy example arn:aws:kafka:us-west-2:123456789012:cluster/example/279c0212-d057-4dba-9aa9-1c4e5a25bfc7-3

Constructors

ClusterPolicy(String name, {ClusterPolicyArgs? args, CustomResourceOptions? options})
Creates a new ClusterPolicy. name The Pulumi resource name. args Arguments used to configure this ClusterPolicy. The set of arguments for ClusterPolicy. options Resource options controlling this resource's behavior.
ClusterPolicy.reference(String urn)
Creates a typed reference to an existing ClusterPolicy resource.

Properties

childResources → Set<Resource>
finalinherited
clusterArn ↔ Output<String>
ARN that uniquely identifies the cluster.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
currentVersion ↔ Output<String>
latefinal
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>
Resource policy for cluster.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
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, {ClusterPolicyState? state, CustomResourceOptions? options}) → ClusterPolicy
Gets an existing ClusterPolicy resource's state with the given name and id.