software.amazon.awssdk.services.sns.model

Class AddPermissionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sns.model.SnsRequest

software.amazon.awssdk.services.sns.model.AddPermissionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AddPermissionRequest.Builder,AddPermissionRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class AddPermissionRequest
extends SnsRequest
implements ToCopyableBuilder<AddPermissionRequest.Builder,AddPermissionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AddPermissionRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	actionNames() The action you want to allow for the specified principal(s).
List<String>	awsAccountIds() The AWS account IDs of the users (principals) who will be given access to the specified actions.
static AddPermissionRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	label() A unique identifier for the new policy statement.
List<SdkField<?>>	sdkFields()
static Class<? extends AddPermissionRequest.Builder>	serializableBuilderClass()
AddPermissionRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	topicArn() The ARN of the topic whose access control policy you wish to modify.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

topicArn

public String topicArn()

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

Returns:

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

label

public String label()

A unique identifier for the new policy statement.

Returns:

A unique identifier for the new policy statement.

awsAccountIds

public List<String> awsAccountIds()

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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.

actionNames

public List<String> actionNames()

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

Valid values: any Amazon SNS action name.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

Valid values: any Amazon SNS action name.

toBuilder

public AddPermissionRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<AddPermissionRequest.Builder,AddPermissionRequest>

Specified by:

toBuilder in class SnsRequest

Returns:

a builder for type T

builder

public static AddPermissionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends AddPermissionRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.