Class: Aws::LocationService::Types::CreateKeyRequest

Inherits:

Struct

• Object
• Struct
• Aws::LocationService::Types::CreateKeyRequest

Includes:

Structure

Defined in:

lib/aws-sdk-locationservice/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  An optional description for the API key resource.

• #expire_time ⇒ Time

  The optional timestamp for when the API key resource will expire in [ ISO 8601] format: ‘YYYY-MM-DDThh:mm:ss.sssZ`.

• #key_name ⇒ String

  A custom name for the API key resource.

• #no_expiry ⇒ Boolean

  Optionally set to ‘true` to set no expiration time for the API key.

• #restrictions ⇒ Types::ApiKeyRestrictions

  The API key restrictions for the API key resource.

• #tags ⇒ Hash<String,String>

  Applies one or more tags to the map resource.

Instance Attribute Details

#description ⇒ String

An optional description for the API key resource.

Returns:

• (String)

# File 'lib/aws-sdk-locationservice/types.rb', line 1484

class CreateKeyRequest < Struct.new(
  :key_name,
  :restrictions,
  :description,
  :expire_time,
  :no_expiry,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#expire_time ⇒ Time

The optional timestamp for when the API key resource will expire in

ISO 8601][1

format: ‘YYYY-MM-DDThh:mm:ss.sssZ`. One of `NoExpiry`

or ‘ExpireTime` must be set.

[1]: www.iso.org/iso-8601-date-and-time-format.html

Returns:

• (Time)

# File 'lib/aws-sdk-locationservice/types.rb', line 1484

class CreateKeyRequest < Struct.new(
  :key_name,
  :restrictions,
  :description,
  :expire_time,
  :no_expiry,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#key_name ⇒ 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`.

Returns:

• (String)

# File 'lib/aws-sdk-locationservice/types.rb', line 1484

class CreateKeyRequest < Struct.new(
  :key_name,
  :restrictions,
  :description,
  :expire_time,
  :no_expiry,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#no_expiry ⇒ Boolean

Optionally set to ‘true` to set no expiration time for the API key. One of `NoExpiry` or `ExpireTime` must be set.

Returns:

• (Boolean)

# File 'lib/aws-sdk-locationservice/types.rb', line 1484

class CreateKeyRequest < Struct.new(
  :key_name,
  :restrictions,
  :description,
  :expire_time,
  :no_expiry,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#restrictions ⇒ Types::ApiKeyRestrictions

The API key restrictions for the API key resource.

Returns:

• (Types::ApiKeyRestrictions)

# File 'lib/aws-sdk-locationservice/types.rb', line 1484

class CreateKeyRequest < Struct.new(
  :key_name,
  :restrictions,
  :description,
  :expire_time,
  :no_expiry,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Applies one or more tags to the map resource. A tag is a key-value pair that helps manage, identify, search, and filter your resources by labelling them.

Format: ‘“key” : “value”`

Restrictions:

• Maximum 50 tags per resource

• Each resource tag must be unique with a maximum of one value.

• Maximum key length: 128 Unicode characters in UTF-8

• Maximum value length: 256 Unicode characters in UTF-8

• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

• Cannot use “aws:” as a prefix for a key.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-locationservice/types.rb', line 1484

class CreateKeyRequest < Struct.new(
  :key_name,
  :restrictions,
  :description,
  :expire_time,
  :no_expiry,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end