@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
107 lines • 3.85 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.ResourcePolicy = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* 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
*
* ```typescript
* 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
*
* ### Identity Schema
*
* #### Required
*
* - `arn` (String) Amazon Resource Name (ARN) of the Kinesis stream.
*
* Using `pulumi import`, import Kinesis resource policies using the `resource_arn`. For example:
*
* console
*
* % pulumi import aws_kinesis_resource_policy.example arn:aws:kinesis:us-west-2:123456789012:stream/example
*/
class ResourcePolicy extends pulumi.CustomResource {
/**
* Get an existing ResourcePolicy 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, id, state, opts) {
return new ResourcePolicy(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of ResourcePolicy. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === ResourcePolicy.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["policy"] = state?.policy;
resourceInputs["region"] = state?.region;
resourceInputs["resourceArn"] = state?.resourceArn;
}
else {
const args = argsOrState;
if (args?.policy === undefined && !opts.urn) {
throw new Error("Missing required property 'policy'");
}
if (args?.resourceArn === undefined && !opts.urn) {
throw new Error("Missing required property 'resourceArn'");
}
resourceInputs["policy"] = args?.policy;
resourceInputs["region"] = args?.region;
resourceInputs["resourceArn"] = args?.resourceArn;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(ResourcePolicy.__pulumiType, name, resourceInputs, opts);
}
}
exports.ResourcePolicy = ResourcePolicy;
/** @internal */
ResourcePolicy.__pulumiType = 'aws:kinesis/resourcePolicy:ResourcePolicy';
//# sourceMappingURL=resourcePolicy.js.map