| 1 | |||
| 2 | package Paws::SNS::SetTopicAttributes; | ||
| 3 | use Moose; | ||
| 4 | has AttributeName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has AttributeValue => (is => 'ro', isa => 'Str'); | ||
| 6 | has TopicArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SetTopicAttributes'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::SNS::SetTopicAttributes - Arguments for method SetTopicAttributes on L<Paws::SNS> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method SetTopicAttributes on the | ||
| 24 | L<Amazon Simple Notification Service|Paws::SNS> service. Use the attributes of this class | ||
| 25 | as arguments to method SetTopicAttributes. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SetTopicAttributes. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $sns = Paws->service('SNS'); | ||
| 32 | $sns->SetTopicAttributes( | ||
| 33 | AttributeName => 'MyattributeName', | ||
| 34 | TopicArn => 'MytopicARN', | ||
| 35 | AttributeValue => 'MyattributeValue', # OPTIONAL | ||
| 36 | ); | ||
| 37 | |||
| 38 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 39 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/sns/SetTopicAttributes> | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 B<REQUIRED> AttributeName => Str | ||
| 45 | |||
| 46 | A map of attributes with their corresponding values. | ||
| 47 | |||
| 48 | The following lists the names, descriptions, and values of the special | ||
| 49 | request parameters that the C<SetTopicAttributes> action uses: | ||
| 50 | |||
| 51 | =over | ||
| 52 | |||
| 53 | =item * | ||
| 54 | |||
| 55 | C<DeliveryPolicy> E<ndash> The policy that defines how Amazon SNS | ||
| 56 | retries failed deliveries to HTTP/S endpoints. | ||
| 57 | |||
| 58 | =item * | ||
| 59 | |||
| 60 | C<DisplayName> E<ndash> The display name to use for a topic with SMS | ||
| 61 | subscriptions. | ||
| 62 | |||
| 63 | =item * | ||
| 64 | |||
| 65 | C<Policy> E<ndash> The policy that defines who can access your topic. | ||
| 66 | By default, only the topic owner can publish or subscribe to the topic. | ||
| 67 | |||
| 68 | =back | ||
| 69 | |||
| 70 | The following attribute applies only to server-side-encryption | ||
| 71 | (https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html): | ||
| 72 | |||
| 73 | =over | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | C<KmsMasterKeyId> E<ndash> The ID of an Amazon Web Services managed | ||
| 78 | customer master key (CMK) for Amazon SNS or a custom CMK. For more | ||
| 79 | information, see Key Terms | ||
| 80 | (https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). | ||
| 81 | For more examples, see KeyId | ||
| 82 | (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) | ||
| 83 | in the I<Key Management Service API Reference>. | ||
| 84 | |||
| 85 | =back | ||
| 86 | |||
| 87 | The following attribute applies only to FIFO topics | ||
| 88 | (https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html): | ||
| 89 | |||
| 90 | =over | ||
| 91 | |||
| 92 | =item * | ||
| 93 | |||
| 94 | C<ContentBasedDeduplication> E<ndash> Enables content-based | ||
| 95 | deduplication for FIFO topics. | ||
| 96 | |||
| 97 | =over | ||
| 98 | |||
| 99 | =item * | ||
| 100 | |||
| 101 | By default, C<ContentBasedDeduplication> is set to C<false>. If you | ||
| 102 | create a FIFO topic and this attribute is C<false>, you must specify a | ||
| 103 | value for the C<MessageDeduplicationId> parameter for the Publish | ||
| 104 | (https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action. | ||
| 105 | |||
| 106 | =item * | ||
| 107 | |||
| 108 | When you set C<ContentBasedDeduplication> to C<true>, Amazon SNS uses a | ||
| 109 | SHA-256 hash to generate the C<MessageDeduplicationId> using the body | ||
| 110 | of the message (but not the attributes of the message). | ||
| 111 | |||
| 112 | (Optional) To override the generated value, you can specify a value for | ||
| 113 | the C<MessageDeduplicationId> parameter for the C<Publish> action. | ||
| 114 | |||
| 115 | =back | ||
| 116 | |||
| 117 | =back | ||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | =head2 AttributeValue => Str | ||
| 123 | |||
| 124 | The new value for the attribute. | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head2 B<REQUIRED> TopicArn => Str | ||
| 129 | |||
| 130 | The ARN of the topic to modify. | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head1 SEE ALSO | ||
| 136 | |||
| 137 | This class forms part of L<Paws>, documenting arguments for method SetTopicAttributes in L<Paws::SNS> | ||
| 138 | |||
| 139 | =head1 BUGS and CONTRIBUTIONS | ||
| 140 | |||
| 141 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 142 | |||
| 143 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 144 | |||
| 145 | =cut | ||
| 146 |