ApiKeyRestrictions (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.location.model.ApiKeyRestrictions

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ApiKeyRestrictions
extends Object
implements Serializable, Cloneable, StructuredPojo
```
API Restrictions on the allowed actions, resources, and referers for an API key resource.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ApiKeyRestrictions()

Constructors
Constructor and Description
`ApiKeyRestrictions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ApiKeyRestrictions`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getAllowActions()` A list of allowed actions that an API key resource grants permissions to perform
`List<String>`	`getAllowReferers()` An optional list of allowed HTTP referers for which requests must originate from.
`List<String>`	`getAllowResources()` A list of allowed resource ARNs that a API key bearer can perform actions on
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAllowActions(Collection<String> allowActions)` A list of allowed actions that an API key resource grants permissions to perform
`void`	`setAllowReferers(Collection<String> allowReferers)` An optional list of allowed HTTP referers for which requests must originate from.
`void`	`setAllowResources(Collection<String> allowResources)` A list of allowed resource ARNs that a API key bearer can perform actions on
`String`	`toString()` Returns a string representation of this object.
`ApiKeyRestrictions`	`withAllowActions(Collection<String> allowActions)` A list of allowed actions that an API key resource grants permissions to perform
`ApiKeyRestrictions`	`withAllowActions(String... allowActions)` A list of allowed actions that an API key resource grants permissions to perform
`ApiKeyRestrictions`	`withAllowReferers(Collection<String> allowReferers)` An optional list of allowed HTTP referers for which requests must originate from.
`ApiKeyRestrictions`	`withAllowReferers(String... allowReferers)` An optional list of allowed HTTP referers for which requests must originate from.
`ApiKeyRestrictions`	`withAllowResources(Collection<String> allowResources)` A list of allowed resource ARNs that a API key bearer can perform actions on
`ApiKeyRestrictions`	`withAllowResources(String... allowResources)` A list of allowed resource ARNs that a API key bearer can perform actions on

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ApiKeyRestrictions
```
public ApiKeyRestrictions()
```
- Method Detail
  - getAllowActions
```
public List<String> getAllowActions()
```
    A list of allowed actions that an API key resource grants permissions to perform
    
    Currently, the only valid action is geo:GetMap* as an input to the list. For example, ["geo:GetMap*"] is valid but ["geo:GetMapTile"] is not.
    
    Returns:
    
    A list of allowed actions that an API key resource grants permissions to perform
    
    Currently, the only valid action is geo:GetMap* as an input to the list. For example, ["geo:GetMap*"] is valid but ["geo:GetMapTile"] is not.
  - setAllowActions
```
public void setAllowActions(Collection<String> allowActions)
```
    A list of allowed actions that an API key resource grants permissions to perform
    
    Currently, the only valid action is geo:GetMap* as an input to the list. For example, ["geo:GetMap*"] is valid but ["geo:GetMapTile"] is not.
    
    Parameters:
    
    allowActions - A list of allowed actions that an API key resource grants permissions to perform
    
    Currently, the only valid action is geo:GetMap* as an input to the list. For example, ["geo:GetMap*"] is valid but ["geo:GetMapTile"] is not.
  - withAllowActions
```
public ApiKeyRestrictions withAllowActions(String... allowActions)
```
    A list of allowed actions that an API key resource grants permissions to perform
    
    Currently, the only valid action is geo:GetMap* as an input to the list. For example, ["geo:GetMap*"] is valid but ["geo:GetMapTile"] is not.
    
    NOTE: This method appends the values to the existing list (if any). Use setAllowActions(java.util.Collection) or withAllowActions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    allowActions - A list of allowed actions that an API key resource grants permissions to perform
    
    Currently, the only valid action is geo:GetMap* as an input to the list. For example, ["geo:GetMap*"] is valid but ["geo:GetMapTile"] is not.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAllowActions
```
public ApiKeyRestrictions withAllowActions(Collection<String> allowActions)
```
    A list of allowed actions that an API key resource grants permissions to perform
    
    Currently, the only valid action is geo:GetMap* as an input to the list. For example, ["geo:GetMap*"] is valid but ["geo:GetMapTile"] is not.
    
    Parameters:
    
    allowActions - A list of allowed actions that an API key resource grants permissions to perform
    
    Currently, the only valid action is geo:GetMap* as an input to the list. For example, ["geo:GetMap*"] is valid but ["geo:GetMapTile"] is not.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAllowReferers
```
public List<String> getAllowReferers()
```
    An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed.
    
    Requirements:
    - Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols in this list $\-._+!*`(),;/?:@=&
    - May contain a percent (%) if followed by 2 hexadecimal digits (A-F, a-f, 0-9); this is used for URL encoding purposes.
    - May contain wildcard characters question mark (?) and asterisk (*).
      
      Question mark (?) will replace any single character (including hexadecimal digits).
      
      Asterisk (*) will replace any multiple characters (including multiple hexadecimal digits).
    - No spaces allowed. For example, https://example.com.
    Returns:
    An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed.
    
    Requirements:
    
    Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols in this list $\-._+!*`(),;/?:@=&
    
    May contain a percent (%) if followed by 2 hexadecimal digits (A-F, a-f, 0-9); this is used for URL encoding purposes.
    
    May contain wildcard characters question mark (?) and asterisk (*).
    
    Question mark (?) will replace any single character (including hexadecimal digits).
    
    Asterisk (*) will replace any multiple characters (including multiple hexadecimal digits).
    
    No spaces allowed. For example, https://example.com.
  - setAllowReferers
```
public void setAllowReferers(Collection<String> allowReferers)
```
    An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed.
    
    Requirements:
    - Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols in this list $\-._+!*`(),;/?:@=&
    - May contain a percent (%) if followed by 2 hexadecimal digits (A-F, a-f, 0-9); this is used for URL encoding purposes.
    - May contain wildcard characters question mark (?) and asterisk (*).
      
      Question mark (?) will replace any single character (including hexadecimal digits).
      
      Asterisk (*) will replace any multiple characters (including multiple hexadecimal digits).
    - No spaces allowed. For example, https://example.com.
    Parameters:
    allowReferers - An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed.
    
    Requirements:
    
    Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols in this list $\-._+!*`(),;/?:@=&
    
    May contain a percent (%) if followed by 2 hexadecimal digits (A-F, a-f, 0-9); this is used for URL encoding purposes.
    
    May contain wildcard characters question mark (?) and asterisk (*).
    
    Question mark (?) will replace any single character (including hexadecimal digits).
    
    Asterisk (*) will replace any multiple characters (including multiple hexadecimal digits).
    
    No spaces allowed. For example, https://example.com.
  - withAllowReferers
```
public ApiKeyRestrictions withAllowReferers(String... allowReferers)
```
    An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed.
    
    Requirements:
    - Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols in this list $\-._+!*`(),;/?:@=&
    - May contain a percent (%) if followed by 2 hexadecimal digits (A-F, a-f, 0-9); this is used for URL encoding purposes.
    - May contain wildcard characters question mark (?) and asterisk (*).
      
      Question mark (?) will replace any single character (including hexadecimal digits).
      
      Asterisk (*) will replace any multiple characters (including multiple hexadecimal digits).
    - No spaces allowed. For example, https://example.com.
    NOTE: This method appends the values to the existing list (if any). Use setAllowReferers(java.util.Collection) or withAllowReferers(java.util.Collection) if you want to override the existing values.
    Parameters:
    allowReferers - An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed.
    
    Requirements:
    
    Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols in this list $\-._+!*`(),;/?:@=&
    
    May contain a percent (%) if followed by 2 hexadecimal digits (A-F, a-f, 0-9); this is used for URL encoding purposes.
    
    May contain wildcard characters question mark (?) and asterisk (*).
    
    Question mark (?) will replace any single character (including hexadecimal digits).
    
    Asterisk (*) will replace any multiple characters (including multiple hexadecimal digits).
    
    No spaces allowed. For example, https://example.com.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAllowReferers
```
public ApiKeyRestrictions withAllowReferers(Collection<String> allowReferers)
```
    An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed.
    
    Requirements:
    - Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols in this list $\-._+!*`(),;/?:@=&
    - May contain a percent (%) if followed by 2 hexadecimal digits (A-F, a-f, 0-9); this is used for URL encoding purposes.
    - May contain wildcard characters question mark (?) and asterisk (*).
      
      Question mark (?) will replace any single character (including hexadecimal digits).
      
      Asterisk (*) will replace any multiple characters (including multiple hexadecimal digits).
    - No spaces allowed. For example, https://example.com.
    Parameters:
    allowReferers - An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed.
    
    Requirements:
    
    Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols in this list $\-._+!*`(),;/?:@=&
    
    May contain a percent (%) if followed by 2 hexadecimal digits (A-F, a-f, 0-9); this is used for URL encoding purposes.
    
    May contain wildcard characters question mark (?) and asterisk (*).
    
    Question mark (?) will replace any single character (including hexadecimal digits).
    
    Asterisk (*) will replace any multiple characters (including multiple hexadecimal digits).
    
    No spaces allowed. For example, https://example.com.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAllowResources
```
public List<String> getAllowResources()
```
    A list of allowed resource ARNs that a API key bearer can perform actions on
    
    For more information about ARN format, see Amazon Resource Names (ARNs).
    
    In this preview, you can allow only map resources.
    
    Requirements:
    - Must be prefixed with arn.
    - partition and service must not be empty and should begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, hyphens (-) and periods (.).
    - region and account-id can be empty or should begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, hyphens (-) and periods (.).
    - resource-id can begin with any character except for forward slash (/) and contain any characters after, including forward slashes to form a path.
      
      resource-id can also include wildcard characters, denoted by an asterisk (*).
    - arn, partition, service, region, account-id and resource-id must be delimited by a colon (:).
    - No spaces allowed. For example, arn:aws:geo:region:account-id:map/ExampleMap*.
    Returns:
    A list of allowed resource ARNs that a API key bearer can perform actions on
    
    For more information about ARN format, see Amazon Resource Names (ARNs).
    
    In this preview, you can allow only map resources.
    
    Requirements:
    
    Must be prefixed with arn.
    
    partition and service must not be empty and should begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, hyphens (-) and periods (.).
    
    region and account-id can be empty or should begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, hyphens (-) and periods (.).
    
    resource-id can begin with any character except for forward slash (/) and contain any characters after, including forward slashes to form a path.
    
    resource-id can also include wildcard characters, denoted by an asterisk (*).
    
    arn, partition, service, region, account-id and resource-id must be delimited by a colon (:).
    
    No spaces allowed. For example, arn:aws:geo:region:account-id:map/ExampleMap*.
  - setAllowResources
```
public void setAllowResources(Collection<String> allowResources)
```
    A list of allowed resource ARNs that a API key bearer can perform actions on
    
    For more information about ARN format, see Amazon Resource Names (ARNs).
    
    In this preview, you can allow only map resources.
    
    Requirements:
    - Must be prefixed with arn.
    - partition and service must not be empty and should begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, hyphens (-) and periods (.).
    - region and account-id can be empty or should begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, hyphens (-) and periods (.).
    - resource-id can begin with any character except for forward slash (/) and contain any characters after, including forward slashes to form a path.
      
      resource-id can also include wildcard characters, denoted by an asterisk (*).
    - arn, partition, service, region, account-id and resource-id must be delimited by a colon (:).
    - No spaces allowed. For example, arn:aws:geo:region:account-id:map/ExampleMap*.
    Parameters:
    allowResources - A list of allowed resource ARNs that a API key bearer can perform actions on
    
    For more information about ARN format, see Amazon Resource Names (ARNs).
    
    In this preview, you can allow only map resources.
    
    Requirements:
    
    Must be prefixed with arn.
    
    partition and service must not be empty and should begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, hyphens (-) and periods (.).
    
    region and account-id can be empty or should begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, hyphens (-) and periods (.).
    
    resource-id can begin with any character except for forward slash (/) and contain any characters after, including forward slashes to form a path.
    
    resource-id can also include wildcard characters, denoted by an asterisk (*).
    
    arn, partition, service, region, account-id and resource-id must be delimited by a colon (:).
    
    No spaces allowed. For example, arn:aws:geo:region:account-id:map/ExampleMap*.
  - withAllowResources
```
public ApiKeyRestrictions withAllowResources(String... allowResources)
```
    A list of allowed resource ARNs that a API key bearer can perform actions on
    
    For more information about ARN format, see Amazon Resource Names (ARNs).
    
    In this preview, you can allow only map resources.
    
    Requirements:
    - Must be prefixed with arn.
    - partition and service must not be empty and should begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, hyphens (-) and periods (.).
    - region and account-id can be empty or should begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, hyphens (-) and periods (.).
    - resource-id can begin with any character except for forward slash (/) and contain any characters after, including forward slashes to form a path.
      
      resource-id can also include wildcard characters, denoted by an asterisk (*).
    - arn, partition, service, region, account-id and resource-id must be delimited by a colon (:).
    - No spaces allowed. For example, arn:aws:geo:region:account-id:map/ExampleMap*.
    NOTE: This method appends the values to the existing list (if any). Use setAllowResources(java.util.Collection) or withAllowResources(java.util.Collection) if you want to override the existing values.
    Parameters:
    allowResources - A list of allowed resource ARNs that a API key bearer can perform actions on
    
    For more information about ARN format, see Amazon Resource Names (ARNs).
    
    In this preview, you can allow only map resources.
    
    Requirements:
    
    Must be prefixed with arn.
    
    partition and service must not be empty and should begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, hyphens (-) and periods (.).
    
    region and account-id can be empty or should begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, hyphens (-) and periods (.).
    
    resource-id can begin with any character except for forward slash (/) and contain any characters after, including forward slashes to form a path.
    
    resource-id can also include wildcard characters, denoted by an asterisk (*).
    
    arn, partition, service, region, account-id and resource-id must be delimited by a colon (:).
    
    No spaces allowed. For example, arn:aws:geo:region:account-id:map/ExampleMap*.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAllowResources
```
public ApiKeyRestrictions withAllowResources(Collection<String> allowResources)
```
    A list of allowed resource ARNs that a API key bearer can perform actions on
    
    For more information about ARN format, see Amazon Resource Names (ARNs).
    
    In this preview, you can allow only map resources.
    
    Requirements:
    - Must be prefixed with arn.
    - partition and service must not be empty and should begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, hyphens (-) and periods (.).
    - region and account-id can be empty or should begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, hyphens (-) and periods (.).
    - resource-id can begin with any character except for forward slash (/) and contain any characters after, including forward slashes to form a path.
      
      resource-id can also include wildcard characters, denoted by an asterisk (*).
    - arn, partition, service, region, account-id and resource-id must be delimited by a colon (:).
    - No spaces allowed. For example, arn:aws:geo:region:account-id:map/ExampleMap*.
    Parameters:
    allowResources - A list of allowed resource ARNs that a API key bearer can perform actions on
    
    For more information about ARN format, see Amazon Resource Names (ARNs).
    
    In this preview, you can allow only map resources.
    
    Requirements:
    
    Must be prefixed with arn.
    
    partition and service must not be empty and should begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, hyphens (-) and periods (.).
    
    region and account-id can be empty or should begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, hyphens (-) and periods (.).
    
    resource-id can begin with any character except for forward slash (/) and contain any characters after, including forward slashes to form a path.
    
    resource-id can also include wildcard characters, denoted by an asterisk (*).
    
    arn, partition, service, region, account-id and resource-id must be delimited by a colon (:).
    
    No spaces allowed. For example, arn:aws:geo:region:account-id:map/ExampleMap*.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ApiKeyRestrictions clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ApiKeyRestrictions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ApiKeyRestrictions

Method Detail

getAllowActions

setAllowActions

withAllowActions

withAllowActions

getAllowReferers

setAllowReferers

withAllowReferers

withAllowReferers

getAllowResources

setAllowResources

withAllowResources

withAllowResources

toString

equals

hashCode

clone

marshall