Docs
PackagesAWS Native is in preview. AWS Classic is fully supported.
aws-native.sns.TopicPolicy
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
The AWS::SNS::TopicPolicy resource associates SNS topics with a policy. For an example snippet, see Declaring an policy in the User Guide.
Create TopicPolicy Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new TopicPolicy(name: string, args: TopicPolicyArgs, opts?: CustomResourceOptions);@overload
def TopicPolicy(resource_name: str,
args: TopicPolicyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def TopicPolicy(resource_name: str,
opts: Optional[ResourceOptions] = None,
policy_document: Optional[Any] = None,
topics: Optional[Sequence[str]] = None)func NewTopicPolicy(ctx *Context, name string, args TopicPolicyArgs, opts ...ResourceOption) (*TopicPolicy, error)public TopicPolicy(string name, TopicPolicyArgs args, CustomResourceOptions? opts = null)
public TopicPolicy(String name, TopicPolicyArgs args)
public TopicPolicy(String name, TopicPolicyArgs args, CustomResourceOptions options)
type: aws-native:sns:TopicPolicy
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 TopicPolicyArgs
- 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 TopicPolicyArgs
- 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 TopicPolicyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TopicPolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TopicPolicyArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
Coming soon!
Coming soon!
Coming soon!
Coming soon!
const topicPolicyResource = new aws_native.sns.TopicPolicy("topicPolicyResource", {
policyDocument: "any",
topics: ["string"],
});
Coming soon!
TopicPolicy Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The TopicPolicy resource accepts the following input properties:
- Policy
Document object A policy document that contains permissions to add to the specified SNS topics.
Search the CloudFormation User Guide for
AWS::SNS::TopicPolicyfor more information about the expected schema for this property.- Topics List<string>
- The Amazon Resource Names (ARN) of the topics to which you want to add the policy. You can use the
Reffunction to specify anAWS::SNS::Topicresource.
- Policy
Document interface{} A policy document that contains permissions to add to the specified SNS topics.
Search the CloudFormation User Guide for
AWS::SNS::TopicPolicyfor more information about the expected schema for this property.- Topics []string
- The Amazon Resource Names (ARN) of the topics to which you want to add the policy. You can use the
Reffunction to specify anAWS::SNS::Topicresource.
- policy
Document Object A policy document that contains permissions to add to the specified SNS topics.
Search the CloudFormation User Guide for
AWS::SNS::TopicPolicyfor more information about the expected schema for this property.- topics List<String>
- The Amazon Resource Names (ARN) of the topics to which you want to add the policy. You can use the
Reffunction to specify anAWS::SNS::Topicresource.
- policy
Document any A policy document that contains permissions to add to the specified SNS topics.
Search the CloudFormation User Guide for
AWS::SNS::TopicPolicyfor more information about the expected schema for this property.- topics string[]
- The Amazon Resource Names (ARN) of the topics to which you want to add the policy. You can use the
Reffunction to specify anAWS::SNS::Topicresource.
- policy_
document Any A policy document that contains permissions to add to the specified SNS topics.
Search the CloudFormation User Guide for
AWS::SNS::TopicPolicyfor more information about the expected schema for this property.- topics Sequence[str]
- The Amazon Resource Names (ARN) of the topics to which you want to add the policy. You can use the
Reffunction to specify anAWS::SNS::Topicresource.
- policy
Document Any A policy document that contains permissions to add to the specified SNS topics.
Search the CloudFormation User Guide for
AWS::SNS::TopicPolicyfor more information about the expected schema for this property.- topics List<String>
- The Amazon Resource Names (ARN) of the topics to which you want to add the policy. You can use the
Reffunction to specify anAWS::SNS::Topicresource.
Outputs
All input properties are implicitly available as output properties. Additionally, the TopicPolicy resource produces the following output properties:
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.