You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SNS::Types::AddPermissionInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb

Overview

Note:

When making an API call, you may pass AddPermissionInput data as a hash:

{
  topic_arn: "topicARN", # required
  label: "label", # required
  aws_account_id: ["delegate"], # required
  action_name: ["action"], # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#action_nameArray<String>

The action you want to allow for the specified principal(s).

Valid values: any Amazon SNS action name.

Returns:

  • (Array<String>)


43
44
45
46
47
48
49
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 43

class AddPermissionInput < Struct.new(
  :topic_arn,
  :label,
  :aws_account_id,
  :action_name)
  include Aws::Structure
end

#aws_account_idArray<String>

The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service.

Returns:

  • (Array<String>)


43
44
45
46
47
48
49
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 43

class AddPermissionInput < Struct.new(
  :topic_arn,
  :label,
  :aws_account_id,
  :action_name)
  include Aws::Structure
end

#labelString

A unique identifier for the new policy statement.

Returns:

  • (String)


43
44
45
46
47
48
49
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 43

class AddPermissionInput < Struct.new(
  :topic_arn,
  :label,
  :aws_account_id,
  :action_name)
  include Aws::Structure
end

#topic_arnString

The ARN of the topic whose access control policy you wish to modify.

Returns:

  • (String)


43
44
45
46
47
48
49
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 43

class AddPermissionInput < Struct.new(
  :topic_arn,
  :label,
  :aws_account_id,
  :action_name)
  include Aws::Structure
end