Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. location
  5. ApiKey

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.location.ApiKey

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::Location::APIKey Resource Type

    Create ApiKey Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ApiKey(name: string, args: ApiKeyArgs, opts?: CustomResourceOptions);
    @overload
def ApiKey(resource_name: str,
           args: ApiKeyArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def ApiKey(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           restrictions: Optional[ApiKeyRestrictionsArgs] = None,
           description: Optional[str] = None,
           expire_time: Optional[str] = None,
           force_delete: Optional[bool] = None,
           force_update: Optional[bool] = None,
           key_name: Optional[str] = None,
           no_expiry: Optional[bool] = None,
           tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewApiKey(ctx *Context, name string, args ApiKeyArgs, opts ...ResourceOption) (*ApiKey, error)
    public ApiKey(string name, ApiKeyArgs args, CustomResourceOptions? opts = null)
    public ApiKey(String name, ApiKeyArgs args)
public ApiKey(String name, ApiKeyArgs args, CustomResourceOptions options)

    type: aws-native:location:ApiKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ApiKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ApiKeyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ApiKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiKeyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ApiKey Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ApiKey resource accepts the following input properties:

    Restrictions Pulumi.AwsNative.Location.Inputs.ApiKeyRestrictions
    The API key restrictions for the API key resource.
    Description string
    Updates the description for the API key resource.
    ExpireTime string
    The optional timestamp for when the API key resource will expire in ISO 8601 format .
    ForceDelete bool

    ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to delete the key or to false to not preemptively delete the API key.

    Valid values: true , or false .

    This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

    ForceUpdate bool
    The boolean flag to be included for updating ExpireTime or Restrictions details. Must be set to true to update an API key resource that has been used in the past 7 days. False if force update is not preferred.
    KeyName string

    A custom name for the API key resource.

    Requirements:

    • Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
    • Must be a unique API key name.
    • No spaces allowed. For example, ExampleAPIKey .
    NoExpiry bool
    Whether the API key should expire. Set to true to set the API key to have no expiration time.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    Restrictions ApiKeyRestrictionsArgs
    The API key restrictions for the API key resource.
    Description string
    Updates the description for the API key resource.
    ExpireTime string
    The optional timestamp for when the API key resource will expire in ISO 8601 format .
    ForceDelete bool

    ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to delete the key or to false to not preemptively delete the API key.

    Valid values: true , or false .

    This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

    ForceUpdate bool
    The boolean flag to be included for updating ExpireTime or Restrictions details. Must be set to true to update an API key resource that has been used in the past 7 days. False if force update is not preferred.
    KeyName string

    A custom name for the API key resource.

    Requirements:

    • Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
    • Must be a unique API key name.
    • No spaces allowed. For example, ExampleAPIKey .
    NoExpiry bool
    Whether the API key should expire. Set to true to set the API key to have no expiration time.
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    restrictions ApiKeyRestrictions
    The API key restrictions for the API key resource.
    description String
    Updates the description for the API key resource.
    expireTime String
    The optional timestamp for when the API key resource will expire in ISO 8601 format .
    forceDelete Boolean

    ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to delete the key or to false to not preemptively delete the API key.

    Valid values: true , or false .

    This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

    forceUpdate Boolean
    The boolean flag to be included for updating ExpireTime or Restrictions details. Must be set to true to update an API key resource that has been used in the past 7 days. False if force update is not preferred.
    keyName String

    A custom name for the API key resource.

    Requirements:

    • Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
    • Must be a unique API key name.
    • No spaces allowed. For example, ExampleAPIKey .
    noExpiry Boolean
    Whether the API key should expire. Set to true to set the API key to have no expiration time.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    restrictions ApiKeyRestrictions
    The API key restrictions for the API key resource.
    description string
    Updates the description for the API key resource.
    expireTime string
    The optional timestamp for when the API key resource will expire in ISO 8601 format .
    forceDelete boolean

    ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to delete the key or to false to not preemptively delete the API key.

    Valid values: true , or false .

    This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

    forceUpdate boolean
    The boolean flag to be included for updating ExpireTime or Restrictions details. Must be set to true to update an API key resource that has been used in the past 7 days. False if force update is not preferred.
    keyName string

    A custom name for the API key resource.

    Requirements:

    • Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
    • Must be a unique API key name.
    • No spaces allowed. For example, ExampleAPIKey .
    noExpiry boolean
    Whether the API key should expire. Set to true to set the API key to have no expiration time.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    restrictions ApiKeyRestrictionsArgs
    The API key restrictions for the API key resource.
    description str
    Updates the description for the API key resource.
    expire_time str
    The optional timestamp for when the API key resource will expire in ISO 8601 format .
    force_delete bool

    ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to delete the key or to false to not preemptively delete the API key.

    Valid values: true , or false .

    This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

    force_update bool
    The boolean flag to be included for updating ExpireTime or Restrictions details. Must be set to true to update an API key resource that has been used in the past 7 days. False if force update is not preferred.
    key_name str

    A custom name for the API key resource.

    Requirements:

    • Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
    • Must be a unique API key name.
    • No spaces allowed. For example, ExampleAPIKey .
    no_expiry bool
    Whether the API key should expire. Set to true to set the API key to have no expiration time.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    restrictions Property Map
    The API key restrictions for the API key resource.
    description String
    Updates the description for the API key resource.
    expireTime String
    The optional timestamp for when the API key resource will expire in ISO 8601 format .
    forceDelete Boolean

    ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to delete the key or to false to not preemptively delete the API key.

    Valid values: true , or false .

    This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

    forceUpdate Boolean
    The boolean flag to be included for updating ExpireTime or Restrictions details. Must be set to true to update an API key resource that has been used in the past 7 days. False if force update is not preferred.
    keyName String

    A custom name for the API key resource.

    Requirements:

    • Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
    • Must be a unique API key name.
    • No spaces allowed. For example, ExampleAPIKey .
    noExpiry Boolean
    Whether the API key should expire. Set to true to set the API key to have no expiration time.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ApiKey resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) for the resource. Used when you need to specify a resource across all AWS .
    CreateTime string
    The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    Id string
    The provider-assigned unique ID for this managed resource.
    KeyArn string
    The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all AWS .
    UpdateTime string
    The timestamp for when the API key resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    Arn string
    The Amazon Resource Name (ARN) for the resource. Used when you need to specify a resource across all AWS .
    CreateTime string
    The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    Id string
    The provider-assigned unique ID for this managed resource.
    KeyArn string
    The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all AWS .
    UpdateTime string
    The timestamp for when the API key resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    arn String
    The Amazon Resource Name (ARN) for the resource. Used when you need to specify a resource across all AWS .
    createTime String
    The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    id String
    The provider-assigned unique ID for this managed resource.
    keyArn String
    The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all AWS .
    updateTime String
    The timestamp for when the API key resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    arn string
    The Amazon Resource Name (ARN) for the resource. Used when you need to specify a resource across all AWS .
    createTime string
    The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    id string
    The provider-assigned unique ID for this managed resource.
    keyArn string
    The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all AWS .
    updateTime string
    The timestamp for when the API key resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    arn str
    The Amazon Resource Name (ARN) for the resource. Used when you need to specify a resource across all AWS .
    create_time str
    The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    id str
    The provider-assigned unique ID for this managed resource.
    key_arn str
    The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all AWS .
    update_time str
    The timestamp for when the API key resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    arn String
    The Amazon Resource Name (ARN) for the resource. Used when you need to specify a resource across all AWS .
    createTime String
    The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    id String
    The provider-assigned unique ID for this managed resource.
    keyArn String
    The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all AWS .
    updateTime String
    The timestamp for when the API key resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

    Supporting Types

    ApiKeyRestrictions, ApiKeyRestrictionsArgs

    AllowActions List<string>

    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.

    • geo: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.

    AllowResources List<string>

    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) .

    AllowReferers List<string>

    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 .
    AllowActions []string

    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.

    • geo: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.

    AllowResources []string

    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) .

    AllowReferers []string

    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 .
    allowActions List<String>

    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.

    • geo: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.

    allowResources List<String>

    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) .

    allowReferers List<String>

    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 .
    allowActions string[]

    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.

    • geo: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.

    allowResources string[]

    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) .

    allowReferers string[]

    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 .
    allow_actions Sequence[str]

    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.

    • geo: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.

    allow_resources Sequence[str]

    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) .

    allow_referers Sequence[str]

    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 .
    allowActions List<String>

    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.

    • geo: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.

    allowResources List<String>

    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) .

    allowReferers List<String>

    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 .

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
    pulumi/pulumi-aws-native