UNPKG

@pulumi/aws-native

Version:

The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)

58 lines (57 loc) 2.89 kB
import * as pulumi from "@pulumi/pulumi"; /** * The ``AWS::SNS::TopicPolicy`` resource associates SNS topics with a policy. For an example snippet, see [Declaring an policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-sns-policy) in the *User Guide*. */ export declare class TopicPolicy extends pulumi.CustomResource { /** * Get an existing TopicPolicy 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 opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): TopicPolicy; /** * Returns true if the given object is an instance of TopicPolicy. 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 TopicPolicy; /** * The provider-assigned unique ID for this managed resource. */ readonly awsId: pulumi.Output<string>; /** * A policy document that contains permissions to add to the specified SNS topics. * * Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::SNS::TopicPolicy` for more information about the expected schema for this property. */ readonly policyDocument: pulumi.Output<any>; /** * The Amazon Resource Names (ARN) of the topics to which you want to add the policy. You can use the ``Ref`` function to specify an ``AWS::SNS::Topic`` resource. */ readonly topics: pulumi.Output<string[]>; /** * Create a TopicPolicy 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: TopicPolicyArgs, opts?: pulumi.CustomResourceOptions); } /** * The set of arguments for constructing a TopicPolicy resource. */ export interface TopicPolicyArgs { /** * A policy document that contains permissions to add to the specified SNS topics. * * Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::SNS::TopicPolicy` for more information about the expected schema for this property. */ policyDocument: any; /** * The Amazon Resource Names (ARN) of the topics to which you want to add the policy. You can use the ``Ref`` function to specify an ``AWS::SNS::Topic`` resource. */ topics: pulumi.Input<pulumi.Input<string>[]>; }