Class: Aws::LocationService::Types::DeleteKeyRequest

Inherits:

Struct

• Object
• Struct
• Aws::LocationService::Types::DeleteKeyRequest

Includes:

Structure

Defined in:

lib/aws-sdk-locationservice/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #force_delete ⇒ Boolean

  ForceDelete bypasses an API key’s expiry conditions and deletes the key.

• #key_name ⇒ String

  The name of the API key to delete.

Instance Attribute Details

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

Required: No

<note markdown=“1”> This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

</note>

Returns:

• (Boolean)

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

class DeleteKeyRequest < Struct.new(
  :key_name,
  :force_delete)
  SENSITIVE = []
  include Aws::Structure
end

#key_name ⇒ String

The name of the API key to delete.

Returns:

• (String)

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

class DeleteKeyRequest < Struct.new(
  :key_name,
  :force_delete)
  SENSITIVE = []
  include Aws::Structure
end