@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
118 lines (117 loc) • 4.55 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Resource for managing an AWS Managed Streaming for Kafka Cluster Policy.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* 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
*
* Using `pulumi import`, import Managed Streaming for Kafka Cluster Policy using the `cluster_arn`. For example:
*
* ```sh
* $ pulumi import aws:msk/clusterPolicy:ClusterPolicy example arn:aws:kafka:us-west-2:123456789012:cluster/example/279c0212-d057-4dba-9aa9-1c4e5a25bfc7-3
* ```
*/
export declare class ClusterPolicy extends pulumi.CustomResource {
/**
* Get an existing ClusterPolicy resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterPolicyState, opts?: pulumi.CustomResourceOptions): ClusterPolicy;
/**
* Returns true if the given object is an instance of ClusterPolicy. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is ClusterPolicy;
/**
* The Amazon Resource Name (ARN) that uniquely identifies the cluster.
*/
readonly clusterArn: pulumi.Output<string>;
readonly currentVersion: pulumi.Output<string>;
/**
* Resource policy for cluster.
*/
readonly policy: pulumi.Output<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* Create a ClusterPolicy resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ClusterPolicyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ClusterPolicy resources.
*/
export interface ClusterPolicyState {
/**
* The Amazon Resource Name (ARN) that uniquely identifies the cluster.
*/
clusterArn?: pulumi.Input<string>;
currentVersion?: pulumi.Input<string>;
/**
* Resource policy for cluster.
*/
policy?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ClusterPolicy resource.
*/
export interface ClusterPolicyArgs {
/**
* The Amazon Resource Name (ARN) that uniquely identifies the cluster.
*/
clusterArn: pulumi.Input<string>;
/**
* Resource policy for cluster.
*/
policy: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
}