sns

package
v0.78.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 27, 2023 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type LookupSubscriptionArgs added in v0.12.0

type LookupSubscriptionArgs struct {
	Id string `pulumi:"id"`
}

type LookupSubscriptionOutputArgs added in v0.12.0

type LookupSubscriptionOutputArgs struct {
	Id pulumi.StringInput `pulumi:"id"`
}

func (LookupSubscriptionOutputArgs) ElementType added in v0.12.0

type LookupSubscriptionResult added in v0.12.0

type LookupSubscriptionResult struct {
	DeliveryPolicy      interface{} `pulumi:"deliveryPolicy"`
	FilterPolicy        interface{} `pulumi:"filterPolicy"`
	FilterPolicyScope   *string     `pulumi:"filterPolicyScope"`
	Id                  *string     `pulumi:"id"`
	RawMessageDelivery  *bool       `pulumi:"rawMessageDelivery"`
	RedrivePolicy       interface{} `pulumi:"redrivePolicy"`
	Region              *string     `pulumi:"region"`
	SubscriptionRoleArn *string     `pulumi:"subscriptionRoleArn"`
}

func LookupSubscription added in v0.12.0

func LookupSubscription(ctx *pulumi.Context, args *LookupSubscriptionArgs, opts ...pulumi.InvokeOption) (*LookupSubscriptionResult, error)

Resource Type definition for AWS::SNS::Subscription

type LookupSubscriptionResultOutput added in v0.12.0

type LookupSubscriptionResultOutput struct{ *pulumi.OutputState }

func LookupSubscriptionOutput added in v0.12.0

func (LookupSubscriptionResultOutput) DeliveryPolicy added in v0.12.0

func (o LookupSubscriptionResultOutput) DeliveryPolicy() pulumi.AnyOutput

func (LookupSubscriptionResultOutput) ElementType added in v0.12.0

func (LookupSubscriptionResultOutput) FilterPolicy added in v0.12.0

func (LookupSubscriptionResultOutput) FilterPolicyScope added in v0.46.0

func (LookupSubscriptionResultOutput) Id added in v0.12.0

func (LookupSubscriptionResultOutput) RawMessageDelivery added in v0.12.0

func (o LookupSubscriptionResultOutput) RawMessageDelivery() pulumi.BoolPtrOutput

func (LookupSubscriptionResultOutput) RedrivePolicy added in v0.12.0

func (LookupSubscriptionResultOutput) Region added in v0.12.0

func (LookupSubscriptionResultOutput) SubscriptionRoleArn added in v0.12.0

func (o LookupSubscriptionResultOutput) SubscriptionRoleArn() pulumi.StringPtrOutput

func (LookupSubscriptionResultOutput) ToLookupSubscriptionResultOutput added in v0.12.0

func (o LookupSubscriptionResultOutput) ToLookupSubscriptionResultOutput() LookupSubscriptionResultOutput

func (LookupSubscriptionResultOutput) ToLookupSubscriptionResultOutputWithContext added in v0.12.0

func (o LookupSubscriptionResultOutput) ToLookupSubscriptionResultOutputWithContext(ctx context.Context) LookupSubscriptionResultOutput

func (LookupSubscriptionResultOutput) ToOutput added in v0.76.0

type LookupTopicArgs added in v0.12.0

type LookupTopicArgs struct {
	TopicArn string `pulumi:"topicArn"`
}

type LookupTopicInlinePolicyArgs added in v0.70.0

type LookupTopicInlinePolicyArgs struct {
	// The Amazon Resource Name (ARN) of the topic to which you want to add the policy.
	TopicArn string `pulumi:"topicArn"`
}

type LookupTopicInlinePolicyOutputArgs added in v0.70.0

type LookupTopicInlinePolicyOutputArgs struct {
	// The Amazon Resource Name (ARN) of the topic to which you want to add the policy.
	TopicArn pulumi.StringInput `pulumi:"topicArn"`
}

func (LookupTopicInlinePolicyOutputArgs) ElementType added in v0.70.0

type LookupTopicInlinePolicyResult added in v0.70.0

type LookupTopicInlinePolicyResult struct {
	// A policy document that contains permissions to add to the specified SNS topics.
	PolicyDocument interface{} `pulumi:"policyDocument"`
}

func LookupTopicInlinePolicy added in v0.70.0

func LookupTopicInlinePolicy(ctx *pulumi.Context, args *LookupTopicInlinePolicyArgs, opts ...pulumi.InvokeOption) (*LookupTopicInlinePolicyResult, error)

Schema for AWS::SNS::TopicInlinePolicy

type LookupTopicInlinePolicyResultOutput added in v0.70.0

type LookupTopicInlinePolicyResultOutput struct{ *pulumi.OutputState }

func LookupTopicInlinePolicyOutput added in v0.70.0

func (LookupTopicInlinePolicyResultOutput) ElementType added in v0.70.0

func (LookupTopicInlinePolicyResultOutput) PolicyDocument added in v0.70.0

A policy document that contains permissions to add to the specified SNS topics.

func (LookupTopicInlinePolicyResultOutput) ToLookupTopicInlinePolicyResultOutput added in v0.70.0

func (o LookupTopicInlinePolicyResultOutput) ToLookupTopicInlinePolicyResultOutput() LookupTopicInlinePolicyResultOutput

func (LookupTopicInlinePolicyResultOutput) ToLookupTopicInlinePolicyResultOutputWithContext added in v0.70.0

func (o LookupTopicInlinePolicyResultOutput) ToLookupTopicInlinePolicyResultOutputWithContext(ctx context.Context) LookupTopicInlinePolicyResultOutput

func (LookupTopicInlinePolicyResultOutput) ToOutput added in v0.76.0

type LookupTopicOutputArgs added in v0.12.0

type LookupTopicOutputArgs struct {
	TopicArn pulumi.StringInput `pulumi:"topicArn"`
}

func (LookupTopicOutputArgs) ElementType added in v0.12.0

func (LookupTopicOutputArgs) ElementType() reflect.Type

type LookupTopicPolicyArgs added in v0.12.0

type LookupTopicPolicyArgs struct {
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
}

type LookupTopicPolicyOutputArgs added in v0.12.0

type LookupTopicPolicyOutputArgs struct {
	// The provider-assigned unique ID for this managed resource.
	Id pulumi.StringInput `pulumi:"id"`
}

func (LookupTopicPolicyOutputArgs) ElementType added in v0.12.0

type LookupTopicPolicyResult added in v0.12.0

type LookupTopicPolicyResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id *string `pulumi:"id"`
	// A policy document that contains permissions to add to the specified SNS topics.
	PolicyDocument interface{} `pulumi:"policyDocument"`
	// The Amazon Resource Names (ARN) of the topics to which you want to add the policy. You can use the [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)` function to specify an [AWS::SNS::Topic](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html) resource.
	Topics []string `pulumi:"topics"`
}

func LookupTopicPolicy added in v0.12.0

func LookupTopicPolicy(ctx *pulumi.Context, args *LookupTopicPolicyArgs, opts ...pulumi.InvokeOption) (*LookupTopicPolicyResult, error)

Schema for AWS::SNS::TopicPolicy

type LookupTopicPolicyResultOutput added in v0.12.0

type LookupTopicPolicyResultOutput struct{ *pulumi.OutputState }

func LookupTopicPolicyOutput added in v0.12.0

func (LookupTopicPolicyResultOutput) ElementType added in v0.12.0

func (LookupTopicPolicyResultOutput) Id added in v0.12.0

The provider-assigned unique ID for this managed resource.

func (LookupTopicPolicyResultOutput) PolicyDocument added in v0.12.0

func (o LookupTopicPolicyResultOutput) PolicyDocument() pulumi.AnyOutput

A policy document that contains permissions to add to the specified SNS topics.

func (LookupTopicPolicyResultOutput) ToLookupTopicPolicyResultOutput added in v0.12.0

func (o LookupTopicPolicyResultOutput) ToLookupTopicPolicyResultOutput() LookupTopicPolicyResultOutput

func (LookupTopicPolicyResultOutput) ToLookupTopicPolicyResultOutputWithContext added in v0.12.0

func (o LookupTopicPolicyResultOutput) ToLookupTopicPolicyResultOutputWithContext(ctx context.Context) LookupTopicPolicyResultOutput

func (LookupTopicPolicyResultOutput) ToOutput added in v0.76.0

func (LookupTopicPolicyResultOutput) Topics added in v0.12.0

The Amazon Resource Names (ARN) of the topics to which you want to add the policy. You can use the [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)` function to specify an [AWS::SNS::Topic](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html) resource.

type LookupTopicResult added in v0.12.0

type LookupTopicResult struct {
	// Enables content-based deduplication for FIFO topics. By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
	//
	// When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
	//
	// (Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action.
	ContentBasedDeduplication *bool `pulumi:"contentBasedDeduplication"`
	// The body of the policy document you want to use for this topic.
	//
	// You can only add one policy per topic.
	//
	// The policy must be in JSON string format.
	//
	// Length Constraints: Maximum length of 30720
	DataProtectionPolicy interface{} `pulumi:"dataProtectionPolicy"`
	// The display name to use for an Amazon SNS topic with SMS subscriptions.
	DisplayName *string `pulumi:"displayName"`
	// The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.
	//
	// This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html).
	KmsMasterKeyId *string `pulumi:"kmsMasterKeyId"`
	// Version of the Amazon SNS signature used. If the SignatureVersion is 1, Signature is a Base64-encoded SHA1withRSA signature of the Message, MessageId, Type, Timestamp, and TopicArn values. If the SignatureVersion is 2, Signature is a Base64-encoded SHA256withRSA signature of the Message, MessageId, Type, Timestamp, and TopicArn values.
	SignatureVersion *string `pulumi:"signatureVersion"`
	// The SNS subscriptions (endpoints) for this topic.
	Subscription []TopicSubscription `pulumi:"subscription"`
	Tags         []TopicTag          `pulumi:"tags"`
	TopicArn     *string             `pulumi:"topicArn"`
	// Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to Active, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. Only supported on standard topics.
	TracingConfig *string `pulumi:"tracingConfig"`
}

func LookupTopic added in v0.12.0

func LookupTopic(ctx *pulumi.Context, args *LookupTopicArgs, opts ...pulumi.InvokeOption) (*LookupTopicResult, error)

Resource Type definition for AWS::SNS::Topic

type LookupTopicResultOutput added in v0.12.0

type LookupTopicResultOutput struct{ *pulumi.OutputState }

func LookupTopicOutput added in v0.12.0

func LookupTopicOutput(ctx *pulumi.Context, args LookupTopicOutputArgs, opts ...pulumi.InvokeOption) LookupTopicResultOutput

func (LookupTopicResultOutput) ContentBasedDeduplication added in v0.12.0

func (o LookupTopicResultOutput) ContentBasedDeduplication() pulumi.BoolPtrOutput

Enables content-based deduplication for FIFO topics. By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.

When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

(Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action.

func (LookupTopicResultOutput) DataProtectionPolicy added in v0.26.0

func (o LookupTopicResultOutput) DataProtectionPolicy() pulumi.AnyOutput

The body of the policy document you want to use for this topic.

You can only add one policy per topic.

The policy must be in JSON string format.

Length Constraints: Maximum length of 30720

func (LookupTopicResultOutput) DisplayName added in v0.12.0

The display name to use for an Amazon SNS topic with SMS subscriptions.

func (LookupTopicResultOutput) ElementType added in v0.12.0

func (LookupTopicResultOutput) ElementType() reflect.Type

func (LookupTopicResultOutput) KmsMasterKeyId added in v0.12.0

func (o LookupTopicResultOutput) KmsMasterKeyId() pulumi.StringPtrOutput

The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.

This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html).

func (LookupTopicResultOutput) SignatureVersion added in v0.38.0

func (o LookupTopicResultOutput) SignatureVersion() pulumi.StringPtrOutput

Version of the Amazon SNS signature used. If the SignatureVersion is 1, Signature is a Base64-encoded SHA1withRSA signature of the Message, MessageId, Type, Timestamp, and TopicArn values. If the SignatureVersion is 2, Signature is a Base64-encoded SHA256withRSA signature of the Message, MessageId, Type, Timestamp, and TopicArn values.

func (LookupTopicResultOutput) Subscription added in v0.12.0

The SNS subscriptions (endpoints) for this topic.

func (LookupTopicResultOutput) Tags added in v0.12.0

func (LookupTopicResultOutput) ToLookupTopicResultOutput added in v0.12.0

func (o LookupTopicResultOutput) ToLookupTopicResultOutput() LookupTopicResultOutput

func (LookupTopicResultOutput) ToLookupTopicResultOutputWithContext added in v0.12.0

func (o LookupTopicResultOutput) ToLookupTopicResultOutputWithContext(ctx context.Context) LookupTopicResultOutput

func (LookupTopicResultOutput) ToOutput added in v0.76.0

func (LookupTopicResultOutput) TopicArn added in v0.21.0

func (LookupTopicResultOutput) TracingConfig added in v0.50.0

Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to Active, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. Only supported on standard topics.

type Subscription deprecated

type Subscription struct {
	pulumi.CustomResourceState

	DeliveryPolicy      pulumi.AnyOutput       `pulumi:"deliveryPolicy"`
	Endpoint            pulumi.StringPtrOutput `pulumi:"endpoint"`
	FilterPolicy        pulumi.AnyOutput       `pulumi:"filterPolicy"`
	FilterPolicyScope   pulumi.StringPtrOutput `pulumi:"filterPolicyScope"`
	Protocol            pulumi.StringOutput    `pulumi:"protocol"`
	RawMessageDelivery  pulumi.BoolPtrOutput   `pulumi:"rawMessageDelivery"`
	RedrivePolicy       pulumi.AnyOutput       `pulumi:"redrivePolicy"`
	Region              pulumi.StringPtrOutput `pulumi:"region"`
	SubscriptionRoleArn pulumi.StringPtrOutput `pulumi:"subscriptionRoleArn"`
	TopicArn            pulumi.StringOutput    `pulumi:"topicArn"`
}

Resource Type definition for AWS::SNS::Subscription

Deprecated: Subscription is not yet supported by AWS Native, so its creation will currently fail. Please use the classic AWS provider, if possible.

func GetSubscription

func GetSubscription(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *SubscriptionState, opts ...pulumi.ResourceOption) (*Subscription, error)

GetSubscription gets an existing Subscription resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewSubscription

func NewSubscription(ctx *pulumi.Context,
	name string, args *SubscriptionArgs, opts ...pulumi.ResourceOption) (*Subscription, error)

NewSubscription registers a new resource with the given unique name, arguments, and options.

func (*Subscription) ElementType

func (*Subscription) ElementType() reflect.Type

func (*Subscription) ToOutput added in v0.76.0

func (*Subscription) ToSubscriptionOutput

func (i *Subscription) ToSubscriptionOutput() SubscriptionOutput

func (*Subscription) ToSubscriptionOutputWithContext

func (i *Subscription) ToSubscriptionOutputWithContext(ctx context.Context) SubscriptionOutput

type SubscriptionArgs

type SubscriptionArgs struct {
	DeliveryPolicy      pulumi.Input
	Endpoint            pulumi.StringPtrInput
	FilterPolicy        pulumi.Input
	FilterPolicyScope   pulumi.StringPtrInput
	Protocol            pulumi.StringInput
	RawMessageDelivery  pulumi.BoolPtrInput
	RedrivePolicy       pulumi.Input
	Region              pulumi.StringPtrInput
	SubscriptionRoleArn pulumi.StringPtrInput
	TopicArn            pulumi.StringInput
}

The set of arguments for constructing a Subscription resource.

func (SubscriptionArgs) ElementType

func (SubscriptionArgs) ElementType() reflect.Type

type SubscriptionInput

type SubscriptionInput interface {
	pulumi.Input

	ToSubscriptionOutput() SubscriptionOutput
	ToSubscriptionOutputWithContext(ctx context.Context) SubscriptionOutput
}

type SubscriptionOutput

type SubscriptionOutput struct{ *pulumi.OutputState }

func (SubscriptionOutput) DeliveryPolicy added in v0.17.0

func (o SubscriptionOutput) DeliveryPolicy() pulumi.AnyOutput

func (SubscriptionOutput) ElementType

func (SubscriptionOutput) ElementType() reflect.Type

func (SubscriptionOutput) Endpoint added in v0.17.0

func (SubscriptionOutput) FilterPolicy added in v0.17.0

func (o SubscriptionOutput) FilterPolicy() pulumi.AnyOutput

func (SubscriptionOutput) FilterPolicyScope added in v0.46.0

func (o SubscriptionOutput) FilterPolicyScope() pulumi.StringPtrOutput

func (SubscriptionOutput) Protocol added in v0.17.0

func (o SubscriptionOutput) Protocol() pulumi.StringOutput

func (SubscriptionOutput) RawMessageDelivery added in v0.17.0

func (o SubscriptionOutput) RawMessageDelivery() pulumi.BoolPtrOutput

func (SubscriptionOutput) RedrivePolicy added in v0.17.0

func (o SubscriptionOutput) RedrivePolicy() pulumi.AnyOutput

func (SubscriptionOutput) Region added in v0.17.0

func (SubscriptionOutput) SubscriptionRoleArn added in v0.17.0

func (o SubscriptionOutput) SubscriptionRoleArn() pulumi.StringPtrOutput

func (SubscriptionOutput) ToOutput added in v0.76.0

func (SubscriptionOutput) ToSubscriptionOutput

func (o SubscriptionOutput) ToSubscriptionOutput() SubscriptionOutput

func (SubscriptionOutput) ToSubscriptionOutputWithContext

func (o SubscriptionOutput) ToSubscriptionOutputWithContext(ctx context.Context) SubscriptionOutput

func (SubscriptionOutput) TopicArn added in v0.17.0

func (o SubscriptionOutput) TopicArn() pulumi.StringOutput

type SubscriptionState

type SubscriptionState struct {
}

func (SubscriptionState) ElementType

func (SubscriptionState) ElementType() reflect.Type

type Topic

type Topic struct {
	pulumi.CustomResourceState

	// Enables content-based deduplication for FIFO topics. By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
	//
	// When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
	//
	// (Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action.
	ContentBasedDeduplication pulumi.BoolPtrOutput `pulumi:"contentBasedDeduplication"`
	// The body of the policy document you want to use for this topic.
	//
	// You can only add one policy per topic.
	//
	// The policy must be in JSON string format.
	//
	// Length Constraints: Maximum length of 30720
	DataProtectionPolicy pulumi.AnyOutput `pulumi:"dataProtectionPolicy"`
	// The display name to use for an Amazon SNS topic with SMS subscriptions.
	DisplayName pulumi.StringPtrOutput `pulumi:"displayName"`
	// Set to true to create a FIFO topic.
	FifoTopic pulumi.BoolPtrOutput `pulumi:"fifoTopic"`
	// The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.
	//
	// This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html).
	KmsMasterKeyId pulumi.StringPtrOutput `pulumi:"kmsMasterKeyId"`
	// Version of the Amazon SNS signature used. If the SignatureVersion is 1, Signature is a Base64-encoded SHA1withRSA signature of the Message, MessageId, Type, Timestamp, and TopicArn values. If the SignatureVersion is 2, Signature is a Base64-encoded SHA256withRSA signature of the Message, MessageId, Type, Timestamp, and TopicArn values.
	SignatureVersion pulumi.StringPtrOutput `pulumi:"signatureVersion"`
	// The SNS subscriptions (endpoints) for this topic.
	Subscription TopicSubscriptionArrayOutput `pulumi:"subscription"`
	Tags         TopicTagArrayOutput          `pulumi:"tags"`
	TopicArn     pulumi.StringOutput          `pulumi:"topicArn"`
	// The name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with .fifo.
	//
	// If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the topic name. For more information, see Name Type.
	TopicName pulumi.StringPtrOutput `pulumi:"topicName"`
	// Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to Active, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. Only supported on standard topics.
	TracingConfig pulumi.StringPtrOutput `pulumi:"tracingConfig"`
}

Resource Type definition for AWS::SNS::Topic

func GetTopic

func GetTopic(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *TopicState, opts ...pulumi.ResourceOption) (*Topic, error)

GetTopic gets an existing Topic resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewTopic

func NewTopic(ctx *pulumi.Context,
	name string, args *TopicArgs, opts ...pulumi.ResourceOption) (*Topic, error)

NewTopic registers a new resource with the given unique name, arguments, and options.

func (*Topic) ElementType

func (*Topic) ElementType() reflect.Type

func (*Topic) ToOutput added in v0.76.0

func (i *Topic) ToOutput(ctx context.Context) pulumix.Output[*Topic]

func (*Topic) ToTopicOutput

func (i *Topic) ToTopicOutput() TopicOutput

func (*Topic) ToTopicOutputWithContext

func (i *Topic) ToTopicOutputWithContext(ctx context.Context) TopicOutput

type TopicArgs

type TopicArgs struct {
	// Enables content-based deduplication for FIFO topics. By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
	//
	// When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
	//
	// (Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action.
	ContentBasedDeduplication pulumi.BoolPtrInput
	// The body of the policy document you want to use for this topic.
	//
	// You can only add one policy per topic.
	//
	// The policy must be in JSON string format.
	//
	// Length Constraints: Maximum length of 30720
	DataProtectionPolicy pulumi.Input
	// The display name to use for an Amazon SNS topic with SMS subscriptions.
	DisplayName pulumi.StringPtrInput
	// Set to true to create a FIFO topic.
	FifoTopic pulumi.BoolPtrInput
	// The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.
	//
	// This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html).
	KmsMasterKeyId pulumi.StringPtrInput
	// Version of the Amazon SNS signature used. If the SignatureVersion is 1, Signature is a Base64-encoded SHA1withRSA signature of the Message, MessageId, Type, Timestamp, and TopicArn values. If the SignatureVersion is 2, Signature is a Base64-encoded SHA256withRSA signature of the Message, MessageId, Type, Timestamp, and TopicArn values.
	SignatureVersion pulumi.StringPtrInput
	// The SNS subscriptions (endpoints) for this topic.
	Subscription TopicSubscriptionArrayInput
	Tags         TopicTagArrayInput
	// The name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with .fifo.
	//
	// If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the topic name. For more information, see Name Type.
	TopicName pulumi.StringPtrInput
	// Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to Active, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. Only supported on standard topics.
	TracingConfig pulumi.StringPtrInput
}

The set of arguments for constructing a Topic resource.

func (TopicArgs) ElementType

func (TopicArgs) ElementType() reflect.Type

type TopicInlinePolicy added in v0.70.0

type TopicInlinePolicy struct {
	pulumi.CustomResourceState

	// A policy document that contains permissions to add to the specified SNS topics.
	PolicyDocument pulumi.AnyOutput `pulumi:"policyDocument"`
	// The Amazon Resource Name (ARN) of the topic to which you want to add the policy.
	TopicArn pulumi.StringOutput `pulumi:"topicArn"`
}

Schema for AWS::SNS::TopicInlinePolicy

func GetTopicInlinePolicy added in v0.70.0

func GetTopicInlinePolicy(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *TopicInlinePolicyState, opts ...pulumi.ResourceOption) (*TopicInlinePolicy, error)

GetTopicInlinePolicy gets an existing TopicInlinePolicy resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewTopicInlinePolicy added in v0.70.0

func NewTopicInlinePolicy(ctx *pulumi.Context,
	name string, args *TopicInlinePolicyArgs, opts ...pulumi.ResourceOption) (*TopicInlinePolicy, error)

NewTopicInlinePolicy registers a new resource with the given unique name, arguments, and options.

func (*TopicInlinePolicy) ElementType added in v0.70.0

func (*TopicInlinePolicy) ElementType() reflect.Type

func (*TopicInlinePolicy) ToOutput added in v0.76.0

func (*TopicInlinePolicy) ToTopicInlinePolicyOutput added in v0.70.0

func (i *TopicInlinePolicy) ToTopicInlinePolicyOutput() TopicInlinePolicyOutput

func (*TopicInlinePolicy) ToTopicInlinePolicyOutputWithContext added in v0.70.0

func (i *TopicInlinePolicy) ToTopicInlinePolicyOutputWithContext(ctx context.Context) TopicInlinePolicyOutput

type TopicInlinePolicyArgs added in v0.70.0

type TopicInlinePolicyArgs struct {
	// A policy document that contains permissions to add to the specified SNS topics.
	PolicyDocument pulumi.Input
	// The Amazon Resource Name (ARN) of the topic to which you want to add the policy.
	TopicArn pulumi.StringInput
}

The set of arguments for constructing a TopicInlinePolicy resource.

func (TopicInlinePolicyArgs) ElementType added in v0.70.0

func (TopicInlinePolicyArgs) ElementType() reflect.Type

type TopicInlinePolicyInput added in v0.70.0

type TopicInlinePolicyInput interface {
	pulumi.Input

	ToTopicInlinePolicyOutput() TopicInlinePolicyOutput
	ToTopicInlinePolicyOutputWithContext(ctx context.Context) TopicInlinePolicyOutput
}

type TopicInlinePolicyOutput added in v0.70.0

type TopicInlinePolicyOutput struct{ *pulumi.OutputState }

func (TopicInlinePolicyOutput) ElementType added in v0.70.0

func (TopicInlinePolicyOutput) ElementType() reflect.Type

func (TopicInlinePolicyOutput) PolicyDocument added in v0.70.0

func (o TopicInlinePolicyOutput) PolicyDocument() pulumi.AnyOutput

A policy document that contains permissions to add to the specified SNS topics.

func (TopicInlinePolicyOutput) ToOutput added in v0.76.0

func (TopicInlinePolicyOutput) ToTopicInlinePolicyOutput added in v0.70.0

func (o TopicInlinePolicyOutput) ToTopicInlinePolicyOutput() TopicInlinePolicyOutput

func (TopicInlinePolicyOutput) ToTopicInlinePolicyOutputWithContext added in v0.70.0

func (o TopicInlinePolicyOutput) ToTopicInlinePolicyOutputWithContext(ctx context.Context) TopicInlinePolicyOutput

func (TopicInlinePolicyOutput) TopicArn added in v0.70.0

The Amazon Resource Name (ARN) of the topic to which you want to add the policy.

type TopicInlinePolicyState added in v0.70.0

type TopicInlinePolicyState struct {
}

func (TopicInlinePolicyState) ElementType added in v0.70.0

func (TopicInlinePolicyState) ElementType() reflect.Type

type TopicInput

type TopicInput interface {
	pulumi.Input

	ToTopicOutput() TopicOutput
	ToTopicOutputWithContext(ctx context.Context) TopicOutput
}

type TopicOutput

type TopicOutput struct{ *pulumi.OutputState }

func (TopicOutput) ContentBasedDeduplication added in v0.17.0

func (o TopicOutput) ContentBasedDeduplication() pulumi.BoolPtrOutput

Enables content-based deduplication for FIFO topics. By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.

When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

(Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action.

func (TopicOutput) DataProtectionPolicy added in v0.26.0

func (o TopicOutput) DataProtectionPolicy() pulumi.AnyOutput

The body of the policy document you want to use for this topic.

You can only add one policy per topic.

The policy must be in JSON string format.

Length Constraints: Maximum length of 30720

func (TopicOutput) DisplayName added in v0.17.0

func (o TopicOutput) DisplayName() pulumi.StringPtrOutput

The display name to use for an Amazon SNS topic with SMS subscriptions.

func (TopicOutput) ElementType

func (TopicOutput) ElementType() reflect.Type

func (TopicOutput) FifoTopic added in v0.17.0

func (o TopicOutput) FifoTopic() pulumi.BoolPtrOutput

Set to true to create a FIFO topic.

func (TopicOutput) KmsMasterKeyId added in v0.17.0

func (o TopicOutput) KmsMasterKeyId() pulumi.StringPtrOutput

The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.

This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html).

func (TopicOutput) SignatureVersion added in v0.38.0

func (o TopicOutput) SignatureVersion() pulumi.StringPtrOutput

Version of the Amazon SNS signature used. If the SignatureVersion is 1, Signature is a Base64-encoded SHA1withRSA signature of the Message, MessageId, Type, Timestamp, and TopicArn values. If the SignatureVersion is 2, Signature is a Base64-encoded SHA256withRSA signature of the Message, MessageId, Type, Timestamp, and TopicArn values.

func (TopicOutput) Subscription added in v0.17.0

func (o TopicOutput) Subscription() TopicSubscriptionArrayOutput

The SNS subscriptions (endpoints) for this topic.

func (TopicOutput) Tags added in v0.17.0

func (TopicOutput) ToOutput added in v0.76.0

func (o TopicOutput) ToOutput(ctx context.Context) pulumix.Output[*Topic]

func (TopicOutput) ToTopicOutput

func (o TopicOutput) ToTopicOutput() TopicOutput

func (TopicOutput) ToTopicOutputWithContext

func (o TopicOutput) ToTopicOutputWithContext(ctx context.Context) TopicOutput

func (TopicOutput) TopicArn added in v0.21.0

func (o TopicOutput) TopicArn() pulumi.StringOutput

func (TopicOutput) TopicName added in v0.17.0

func (o TopicOutput) TopicName() pulumi.StringPtrOutput

The name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with .fifo.

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the topic name. For more information, see Name Type.

func (TopicOutput) TracingConfig added in v0.50.0

func (o TopicOutput) TracingConfig() pulumi.StringPtrOutput

Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to Active, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. Only supported on standard topics.

type TopicPolicy

type TopicPolicy struct {
	pulumi.CustomResourceState

	// A policy document that contains permissions to add to the specified SNS topics.
	PolicyDocument pulumi.AnyOutput `pulumi:"policyDocument"`
	// The Amazon Resource Names (ARN) of the topics to which you want to add the policy. You can use the [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)` function to specify an [AWS::SNS::Topic](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html) resource.
	Topics pulumi.StringArrayOutput `pulumi:"topics"`
}

Schema for AWS::SNS::TopicPolicy

func GetTopicPolicy

func GetTopicPolicy(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *TopicPolicyState, opts ...pulumi.ResourceOption) (*TopicPolicy, error)

GetTopicPolicy gets an existing TopicPolicy resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewTopicPolicy

func NewTopicPolicy(ctx *pulumi.Context,
	name string, args *TopicPolicyArgs, opts ...pulumi.ResourceOption) (*TopicPolicy, error)

NewTopicPolicy registers a new resource with the given unique name, arguments, and options.

func (*TopicPolicy) ElementType

func (*TopicPolicy) ElementType() reflect.Type

func (*TopicPolicy) ToOutput added in v0.76.0

func (i *TopicPolicy) ToOutput(ctx context.Context) pulumix.Output[*TopicPolicy]

func (*TopicPolicy) ToTopicPolicyOutput

func (i *TopicPolicy) ToTopicPolicyOutput() TopicPolicyOutput

func (*TopicPolicy) ToTopicPolicyOutputWithContext

func (i *TopicPolicy) ToTopicPolicyOutputWithContext(ctx context.Context) TopicPolicyOutput

type TopicPolicyArgs

type TopicPolicyArgs struct {
	// A policy document that contains permissions to add to the specified SNS topics.
	PolicyDocument pulumi.Input
	// The Amazon Resource Names (ARN) of the topics to which you want to add the policy. You can use the [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)` function to specify an [AWS::SNS::Topic](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html) resource.
	Topics pulumi.StringArrayInput
}

The set of arguments for constructing a TopicPolicy resource.

func (TopicPolicyArgs) ElementType

func (TopicPolicyArgs) ElementType() reflect.Type

type TopicPolicyInput

type TopicPolicyInput interface {
	pulumi.Input

	ToTopicPolicyOutput() TopicPolicyOutput
	ToTopicPolicyOutputWithContext(ctx context.Context) TopicPolicyOutput
}

type TopicPolicyOutput

type TopicPolicyOutput struct{ *pulumi.OutputState }

func (TopicPolicyOutput) ElementType

func (TopicPolicyOutput) ElementType() reflect.Type

func (TopicPolicyOutput) PolicyDocument added in v0.17.0

func (o TopicPolicyOutput) PolicyDocument() pulumi.AnyOutput

A policy document that contains permissions to add to the specified SNS topics.

func (TopicPolicyOutput) ToOutput added in v0.76.0

func (TopicPolicyOutput) ToTopicPolicyOutput

func (o TopicPolicyOutput) ToTopicPolicyOutput() TopicPolicyOutput

func (TopicPolicyOutput) ToTopicPolicyOutputWithContext

func (o TopicPolicyOutput) ToTopicPolicyOutputWithContext(ctx context.Context) TopicPolicyOutput

func (TopicPolicyOutput) Topics added in v0.17.0

The Amazon Resource Names (ARN) of the topics to which you want to add the policy. You can use the [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)` function to specify an [AWS::SNS::Topic](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html) resource.

type TopicPolicyState

type TopicPolicyState struct {
}

func (TopicPolicyState) ElementType

func (TopicPolicyState) ElementType() reflect.Type

type TopicState

type TopicState struct {
}

func (TopicState) ElementType

func (TopicState) ElementType() reflect.Type

type TopicSubscription

type TopicSubscription struct {
	Endpoint string `pulumi:"endpoint"`
	Protocol string `pulumi:"protocol"`
}

type TopicSubscriptionArgs

type TopicSubscriptionArgs struct {
	Endpoint pulumi.StringInput `pulumi:"endpoint"`
	Protocol pulumi.StringInput `pulumi:"protocol"`
}

func (TopicSubscriptionArgs) ElementType

func (TopicSubscriptionArgs) ElementType() reflect.Type

func (TopicSubscriptionArgs) ToOutput added in v0.76.0

func (TopicSubscriptionArgs) ToTopicSubscriptionOutput

func (i TopicSubscriptionArgs) ToTopicSubscriptionOutput() TopicSubscriptionOutput

func (TopicSubscriptionArgs) ToTopicSubscriptionOutputWithContext

func (i TopicSubscriptionArgs) ToTopicSubscriptionOutputWithContext(ctx context.Context) TopicSubscriptionOutput

type TopicSubscriptionArray

type TopicSubscriptionArray []TopicSubscriptionInput

func (TopicSubscriptionArray) ElementType

func (TopicSubscriptionArray) ElementType() reflect.Type

func (TopicSubscriptionArray) ToOutput added in v0.76.0

func (TopicSubscriptionArray) ToTopicSubscriptionArrayOutput

func (i TopicSubscriptionArray) ToTopicSubscriptionArrayOutput() TopicSubscriptionArrayOutput

func (TopicSubscriptionArray) ToTopicSubscriptionArrayOutputWithContext

func (i TopicSubscriptionArray) ToTopicSubscriptionArrayOutputWithContext(ctx context.Context) TopicSubscriptionArrayOutput

type TopicSubscriptionArrayInput

type TopicSubscriptionArrayInput interface {
	pulumi.Input

	ToTopicSubscriptionArrayOutput() TopicSubscriptionArrayOutput
	ToTopicSubscriptionArrayOutputWithContext(context.Context) TopicSubscriptionArrayOutput
}

TopicSubscriptionArrayInput is an input type that accepts TopicSubscriptionArray and TopicSubscriptionArrayOutput values. You can construct a concrete instance of `TopicSubscriptionArrayInput` via:

TopicSubscriptionArray{ TopicSubscriptionArgs{...} }

type TopicSubscriptionArrayOutput

type TopicSubscriptionArrayOutput struct{ *pulumi.OutputState }

func (TopicSubscriptionArrayOutput) ElementType

func (TopicSubscriptionArrayOutput) Index

func (TopicSubscriptionArrayOutput) ToOutput added in v0.76.0

func (TopicSubscriptionArrayOutput) ToTopicSubscriptionArrayOutput

func (o TopicSubscriptionArrayOutput) ToTopicSubscriptionArrayOutput() TopicSubscriptionArrayOutput

func (TopicSubscriptionArrayOutput) ToTopicSubscriptionArrayOutputWithContext

func (o TopicSubscriptionArrayOutput) ToTopicSubscriptionArrayOutputWithContext(ctx context.Context) TopicSubscriptionArrayOutput

type TopicSubscriptionInput

type TopicSubscriptionInput interface {
	pulumi.Input

	ToTopicSubscriptionOutput() TopicSubscriptionOutput
	ToTopicSubscriptionOutputWithContext(context.Context) TopicSubscriptionOutput
}

TopicSubscriptionInput is an input type that accepts TopicSubscriptionArgs and TopicSubscriptionOutput values. You can construct a concrete instance of `TopicSubscriptionInput` via:

TopicSubscriptionArgs{...}

type TopicSubscriptionOutput

type TopicSubscriptionOutput struct{ *pulumi.OutputState }

func (TopicSubscriptionOutput) ElementType

func (TopicSubscriptionOutput) ElementType() reflect.Type

func (TopicSubscriptionOutput) Endpoint

func (TopicSubscriptionOutput) Protocol

func (TopicSubscriptionOutput) ToOutput added in v0.76.0

func (TopicSubscriptionOutput) ToTopicSubscriptionOutput

func (o TopicSubscriptionOutput) ToTopicSubscriptionOutput() TopicSubscriptionOutput

func (TopicSubscriptionOutput) ToTopicSubscriptionOutputWithContext

func (o TopicSubscriptionOutput) ToTopicSubscriptionOutputWithContext(ctx context.Context) TopicSubscriptionOutput

type TopicTag

type TopicTag struct {
	// The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, `_`, `.`, `/`, `=`, `+`, and `-`.
	Key string `pulumi:"key"`
	// The value for the tag. You can specify a value that is 0 to 256 characters in length.
	Value string `pulumi:"value"`
}

type TopicTagArgs

type TopicTagArgs struct {
	// The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, `_`, `.`, `/`, `=`, `+`, and `-`.
	Key pulumi.StringInput `pulumi:"key"`
	// The value for the tag. You can specify a value that is 0 to 256 characters in length.
	Value pulumi.StringInput `pulumi:"value"`
}

func (TopicTagArgs) ElementType

func (TopicTagArgs) ElementType() reflect.Type

func (TopicTagArgs) ToOutput added in v0.76.0

func (TopicTagArgs) ToTopicTagOutput

func (i TopicTagArgs) ToTopicTagOutput() TopicTagOutput

func (TopicTagArgs) ToTopicTagOutputWithContext

func (i TopicTagArgs) ToTopicTagOutputWithContext(ctx context.Context) TopicTagOutput

type TopicTagArray

type TopicTagArray []TopicTagInput

func (TopicTagArray) ElementType

func (TopicTagArray) ElementType() reflect.Type

func (TopicTagArray) ToOutput added in v0.76.0

func (i TopicTagArray) ToOutput(ctx context.Context) pulumix.Output[[]TopicTag]

func (TopicTagArray) ToTopicTagArrayOutput

func (i TopicTagArray) ToTopicTagArrayOutput() TopicTagArrayOutput

func (TopicTagArray) ToTopicTagArrayOutputWithContext

func (i TopicTagArray) ToTopicTagArrayOutputWithContext(ctx context.Context) TopicTagArrayOutput

type TopicTagArrayInput

type TopicTagArrayInput interface {
	pulumi.Input

	ToTopicTagArrayOutput() TopicTagArrayOutput
	ToTopicTagArrayOutputWithContext(context.Context) TopicTagArrayOutput
}

TopicTagArrayInput is an input type that accepts TopicTagArray and TopicTagArrayOutput values. You can construct a concrete instance of `TopicTagArrayInput` via:

TopicTagArray{ TopicTagArgs{...} }

type TopicTagArrayOutput

type TopicTagArrayOutput struct{ *pulumi.OutputState }

func (TopicTagArrayOutput) ElementType

func (TopicTagArrayOutput) ElementType() reflect.Type

func (TopicTagArrayOutput) Index

func (TopicTagArrayOutput) ToOutput added in v0.76.0

func (TopicTagArrayOutput) ToTopicTagArrayOutput

func (o TopicTagArrayOutput) ToTopicTagArrayOutput() TopicTagArrayOutput

func (TopicTagArrayOutput) ToTopicTagArrayOutputWithContext

func (o TopicTagArrayOutput) ToTopicTagArrayOutputWithContext(ctx context.Context) TopicTagArrayOutput

type TopicTagInput

type TopicTagInput interface {
	pulumi.Input

	ToTopicTagOutput() TopicTagOutput
	ToTopicTagOutputWithContext(context.Context) TopicTagOutput
}

TopicTagInput is an input type that accepts TopicTagArgs and TopicTagOutput values. You can construct a concrete instance of `TopicTagInput` via:

TopicTagArgs{...}

type TopicTagOutput

type TopicTagOutput struct{ *pulumi.OutputState }

func (TopicTagOutput) ElementType

func (TopicTagOutput) ElementType() reflect.Type

func (TopicTagOutput) Key

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, `_`, `.`, `/`, `=`, `+`, and `-`.

func (TopicTagOutput) ToOutput added in v0.76.0

func (TopicTagOutput) ToTopicTagOutput

func (o TopicTagOutput) ToTopicTagOutput() TopicTagOutput

func (TopicTagOutput) ToTopicTagOutputWithContext

func (o TopicTagOutput) ToTopicTagOutputWithContext(ctx context.Context) TopicTagOutput

func (TopicTagOutput) Value

The value for the tag. You can specify a value that is 0 to 256 characters in length.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL