@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.
Constructor and Description |
---|
ApiKeyRestrictions() |
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.
|
public List<String> getAllowActions()
A list of allowed actions that an API key resource grants permissions to perform. You must have at least one action for each type of resource. For example, if you have a place resource, you must include at least one place action.
The following are valid values for the actions.
Map actions
geo:GetMap*
- Allows all actions needed for map rendering.
Place actions
geo:SearchPlaceIndexForText
- Allows geocoding.
geo:SearchPlaceIndexForPosition
- Allows reverse geocoding.
geo:SearchPlaceIndexForSuggestions
- Allows generating suggestions from text.
GetPlace
- Allows finding a place by place ID.
Route actions
geo:CalculateRoute
- Allows point to point routing.
geo:CalculateRouteMatrix
- Allows calculating a matrix of routes.
You must use these strings exactly. For example, to provide access to map rendering, the only valid action is
geo:GetMap*
as an input to the list. ["geo:GetMap*"]
is valid but
["geo:GetMapTile"]
is not. Similarly, you cannot use ["geo:SearchPlaceIndexFor*"]
- you
must list each of the Place actions separately.
The following are valid values for the actions.
Map actions
geo:GetMap*
- Allows all actions needed for map rendering.
Place actions
geo:SearchPlaceIndexForText
- Allows geocoding.
geo:SearchPlaceIndexForPosition
- Allows reverse geocoding.
geo:SearchPlaceIndexForSuggestions
- Allows generating suggestions from text.
GetPlace
- Allows finding a place by place ID.
Route actions
geo:CalculateRoute
- Allows point to point routing.
geo:CalculateRouteMatrix
- Allows calculating a matrix of routes.
You must use these strings exactly. For example, to provide access to map rendering, the only valid
action is geo:GetMap*
as an input to the list. ["geo:GetMap*"]
is valid but
["geo:GetMapTile"]
is not. Similarly, you cannot use
["geo:SearchPlaceIndexFor*"]
- you must list each of the Place actions separately.
public void setAllowActions(Collection<String> allowActions)
A list of allowed actions that an API key resource grants permissions to perform. You must have at least one action for each type of resource. For example, if you have a place resource, you must include at least one place action.
The following are valid values for the actions.
Map actions
geo:GetMap*
- Allows all actions needed for map rendering.
Place actions
geo:SearchPlaceIndexForText
- Allows geocoding.
geo:SearchPlaceIndexForPosition
- Allows reverse geocoding.
geo:SearchPlaceIndexForSuggestions
- Allows generating suggestions from text.
GetPlace
- Allows finding a place by place ID.
Route actions
geo:CalculateRoute
- Allows point to point routing.
geo:CalculateRouteMatrix
- Allows calculating a matrix of routes.
You must use these strings exactly. For example, to provide access to map rendering, the only valid action is
geo:GetMap*
as an input to the list. ["geo:GetMap*"]
is valid but
["geo:GetMapTile"]
is not. Similarly, you cannot use ["geo:SearchPlaceIndexFor*"]
- you
must list each of the Place actions separately.
allowActions
- A list of allowed actions that an API key resource grants permissions to perform. You must have at least
one action for each type of resource. For example, if you have a place resource, you must include at least
one place action.
The following are valid values for the actions.
Map actions
geo:GetMap*
- Allows all actions needed for map rendering.
Place actions
geo:SearchPlaceIndexForText
- Allows geocoding.
geo:SearchPlaceIndexForPosition
- Allows reverse geocoding.
geo:SearchPlaceIndexForSuggestions
- Allows generating suggestions from text.
GetPlace
- Allows finding a place by place ID.
Route actions
geo:CalculateRoute
- Allows point to point routing.
geo:CalculateRouteMatrix
- Allows calculating a matrix of routes.
You must use these strings exactly. For example, to provide access to map rendering, the only valid action
is geo:GetMap*
as an input to the list. ["geo:GetMap*"]
is valid but
["geo:GetMapTile"]
is not. Similarly, you cannot use
["geo:SearchPlaceIndexFor*"]
- you must list each of the Place actions separately.
public ApiKeyRestrictions withAllowActions(String... allowActions)
A list of allowed actions that an API key resource grants permissions to perform. You must have at least one action for each type of resource. For example, if you have a place resource, you must include at least one place action.
The following are valid values for the actions.
Map actions
geo:GetMap*
- Allows all actions needed for map rendering.
Place actions
geo:SearchPlaceIndexForText
- Allows geocoding.
geo:SearchPlaceIndexForPosition
- Allows reverse geocoding.
geo:SearchPlaceIndexForSuggestions
- Allows generating suggestions from text.
GetPlace
- Allows finding a place by place ID.
Route actions
geo:CalculateRoute
- Allows point to point routing.
geo:CalculateRouteMatrix
- Allows calculating a matrix of routes.
You must use these strings exactly. For example, to provide access to map rendering, the only valid action is
geo:GetMap*
as an input to the list. ["geo:GetMap*"]
is valid but
["geo:GetMapTile"]
is not. Similarly, you cannot use ["geo:SearchPlaceIndexFor*"]
- you
must list each of the Place actions separately.
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.
allowActions
- A list of allowed actions that an API key resource grants permissions to perform. You must have at least
one action for each type of resource. For example, if you have a place resource, you must include at least
one place action.
The following are valid values for the actions.
Map actions
geo:GetMap*
- Allows all actions needed for map rendering.
Place actions
geo:SearchPlaceIndexForText
- Allows geocoding.
geo:SearchPlaceIndexForPosition
- Allows reverse geocoding.
geo:SearchPlaceIndexForSuggestions
- Allows generating suggestions from text.
GetPlace
- Allows finding a place by place ID.
Route actions
geo:CalculateRoute
- Allows point to point routing.
geo:CalculateRouteMatrix
- Allows calculating a matrix of routes.
You must use these strings exactly. For example, to provide access to map rendering, the only valid action
is geo:GetMap*
as an input to the list. ["geo:GetMap*"]
is valid but
["geo:GetMapTile"]
is not. Similarly, you cannot use
["geo:SearchPlaceIndexFor*"]
- you must list each of the Place actions separately.
public ApiKeyRestrictions withAllowActions(Collection<String> allowActions)
A list of allowed actions that an API key resource grants permissions to perform. You must have at least one action for each type of resource. For example, if you have a place resource, you must include at least one place action.
The following are valid values for the actions.
Map actions
geo:GetMap*
- Allows all actions needed for map rendering.
Place actions
geo:SearchPlaceIndexForText
- Allows geocoding.
geo:SearchPlaceIndexForPosition
- Allows reverse geocoding.
geo:SearchPlaceIndexForSuggestions
- Allows generating suggestions from text.
GetPlace
- Allows finding a place by place ID.
Route actions
geo:CalculateRoute
- Allows point to point routing.
geo:CalculateRouteMatrix
- Allows calculating a matrix of routes.
You must use these strings exactly. For example, to provide access to map rendering, the only valid action is
geo:GetMap*
as an input to the list. ["geo:GetMap*"]
is valid but
["geo:GetMapTile"]
is not. Similarly, you cannot use ["geo:SearchPlaceIndexFor*"]
- you
must list each of the Place actions separately.
allowActions
- A list of allowed actions that an API key resource grants permissions to perform. You must have at least
one action for each type of resource. For example, if you have a place resource, you must include at least
one place action.
The following are valid values for the actions.
Map actions
geo:GetMap*
- Allows all actions needed for map rendering.
Place actions
geo:SearchPlaceIndexForText
- Allows geocoding.
geo:SearchPlaceIndexForPosition
- Allows reverse geocoding.
geo:SearchPlaceIndexForSuggestions
- Allows generating suggestions from text.
GetPlace
- Allows finding a place by place ID.
Route actions
geo:CalculateRoute
- Allows point to point routing.
geo:CalculateRouteMatrix
- Allows calculating a matrix of routes.
You must use these strings exactly. For example, to provide access to map rendering, the only valid action
is geo:GetMap*
as an input to the list. ["geo:GetMap*"]
is valid but
["geo:GetMapTile"]
is not. Similarly, you cannot use
["geo:SearchPlaceIndexFor*"]
- you must list each of the Place actions separately.
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
.
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
.
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
.
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
.
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.
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
.
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
.
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
.
public List<String> getAllowResources()
A list of allowed resource ARNs that a API key bearer can perform actions on.
The ARN must be the correct ARN for a map, place, or route ARN. You may include wildcards in the resource-id to match multiple resources of the same type.
The resources must be in the same partition
, region
, and account-id
as the
key that is being created.
Other than wildcards, you must include the full ARN, including the arn
, partition
,
service
, region
, account-id
and resource-id
delimited by
colons (:).
No spaces allowed, even with wildcards. For example,
arn:aws:geo:region:account-id:map/ExampleMap*
.
For more information about ARN format, see Amazon Resource Names (ARNs).
The ARN must be the correct ARN for a map, place, or route ARN. You may include wildcards in the resource-id to match multiple resources of the same type.
The resources must be in the same partition
, region
, and
account-id
as the key that is being created.
Other than wildcards, you must include the full ARN, including the arn
,
partition
, service
, region
, account-id
and
resource-id
delimited by colons (:).
No spaces allowed, even with wildcards. For example,
arn:aws:geo:region:account-id:map/ExampleMap*
.
For more information about ARN format, see Amazon Resource Names (ARNs).
public void setAllowResources(Collection<String> allowResources)
A list of allowed resource ARNs that a API key bearer can perform actions on.
The ARN must be the correct ARN for a map, place, or route ARN. You may include wildcards in the resource-id to match multiple resources of the same type.
The resources must be in the same partition
, region
, and account-id
as the
key that is being created.
Other than wildcards, you must include the full ARN, including the arn
, partition
,
service
, region
, account-id
and resource-id
delimited by
colons (:).
No spaces allowed, even with wildcards. For example,
arn:aws:geo:region:account-id:map/ExampleMap*
.
For more information about ARN format, see Amazon Resource Names (ARNs).
allowResources
- A list of allowed resource ARNs that a API key bearer can perform actions on.
The ARN must be the correct ARN for a map, place, or route ARN. You may include wildcards in the resource-id to match multiple resources of the same type.
The resources must be in the same partition
, region
, and account-id
as the key that is being created.
Other than wildcards, you must include the full ARN, including the arn
,
partition
, service
, region
, account-id
and
resource-id
delimited by colons (:).
No spaces allowed, even with wildcards. For example,
arn:aws:geo:region:account-id:map/ExampleMap*
.
For more information about ARN format, see Amazon Resource Names (ARNs).
public ApiKeyRestrictions withAllowResources(String... allowResources)
A list of allowed resource ARNs that a API key bearer can perform actions on.
The ARN must be the correct ARN for a map, place, or route ARN. You may include wildcards in the resource-id to match multiple resources of the same type.
The resources must be in the same partition
, region
, and account-id
as the
key that is being created.
Other than wildcards, you must include the full ARN, including the arn
, partition
,
service
, region
, account-id
and resource-id
delimited by
colons (:).
No spaces allowed, even with wildcards. For example,
arn:aws:geo:region:account-id:map/ExampleMap*
.
For more information about ARN format, see Amazon Resource Names (ARNs).
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.
allowResources
- A list of allowed resource ARNs that a API key bearer can perform actions on.
The ARN must be the correct ARN for a map, place, or route ARN. You may include wildcards in the resource-id to match multiple resources of the same type.
The resources must be in the same partition
, region
, and account-id
as the key that is being created.
Other than wildcards, you must include the full ARN, including the arn
,
partition
, service
, region
, account-id
and
resource-id
delimited by colons (:).
No spaces allowed, even with wildcards. For example,
arn:aws:geo:region:account-id:map/ExampleMap*
.
For more information about ARN format, see Amazon Resource Names (ARNs).
public ApiKeyRestrictions withAllowResources(Collection<String> allowResources)
A list of allowed resource ARNs that a API key bearer can perform actions on.
The ARN must be the correct ARN for a map, place, or route ARN. You may include wildcards in the resource-id to match multiple resources of the same type.
The resources must be in the same partition
, region
, and account-id
as the
key that is being created.
Other than wildcards, you must include the full ARN, including the arn
, partition
,
service
, region
, account-id
and resource-id
delimited by
colons (:).
No spaces allowed, even with wildcards. For example,
arn:aws:geo:region:account-id:map/ExampleMap*
.
For more information about ARN format, see Amazon Resource Names (ARNs).
allowResources
- A list of allowed resource ARNs that a API key bearer can perform actions on.
The ARN must be the correct ARN for a map, place, or route ARN. You may include wildcards in the resource-id to match multiple resources of the same type.
The resources must be in the same partition
, region
, and account-id
as the key that is being created.
Other than wildcards, you must include the full ARN, including the arn
,
partition
, service
, region
, account-id
and
resource-id
delimited by colons (:).
No spaces allowed, even with wildcards. For example,
arn:aws:geo:region:account-id:map/ExampleMap*
.
For more information about ARN format, see Amazon Resource Names (ARNs).
public String toString()
toString
in class Object
Object.toString()
public ApiKeyRestrictions clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.