software.amazon.awssdk.services.location.model

Interface ApiKeyRestrictions.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ApiKeyRestrictions.Builder,ApiKeyRestrictions>, SdkBuilder<ApiKeyRestrictions.Builder,ApiKeyRestrictions>, SdkPojo

Enclosing class:

ApiKeyRestrictions

public static interface ApiKeyRestrictions.Builder
extends SdkPojo, CopyableBuilder<ApiKeyRestrictions.Builder,ApiKeyRestrictions>

Method Summary

Modifier and Type	Method and Description
ApiKeyRestrictions.Builder	allowActions(Collection<String> allowActions) A list of allowed actions that an API key resource grants permissions to perform
ApiKeyRestrictions.Builder	allowActions(String... allowActions) A list of allowed actions that an API key resource grants permissions to perform
ApiKeyRestrictions.Builder	allowReferers(Collection<String> allowReferers) An optional list of allowed HTTP referers for which requests must originate from.
ApiKeyRestrictions.Builder	allowReferers(String... allowReferers) An optional list of allowed HTTP referers for which requests must originate from.
ApiKeyRestrictions.Builder	allowResources(Collection<String> allowResources) A list of allowed resource ARNs that a API key bearer can perform actions on
ApiKeyRestrictions.Builder	allowResources(String... allowResources) A list of allowed resource ARNs that a API key bearer can perform actions on

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

allowActions

ApiKeyRestrictions.Builder allowActions(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.

allowActions

ApiKeyRestrictions.Builder allowActions(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.

allowReferers

ApiKeyRestrictions.Builder allowReferers(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.

allowReferers

ApiKeyRestrictions.Builder allowReferers(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.

allowResources

ApiKeyRestrictions.Builder allowResources(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.

allowResources

ApiKeyRestrictions.Builder allowResources(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.