Class: Aws::ManagedGrafana::Types::CreateWorkspaceApiKeyRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-managedgrafana/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#key_nameString

Specifies the name of the key. Keynames must be unique to the workspace.

Returns:

  • (String)


234
235
236
237
238
239
240
241
# File 'lib/aws-sdk-managedgrafana/types.rb', line 234

class CreateWorkspaceApiKeyRequest < Struct.new(
  :key_name,
  :key_role,
  :seconds_to_live,
  :workspace_id)
  SENSITIVE = []
  include Aws::Structure
end

#key_roleString

Specifies the permission level of the key.

Valid values: ‘ADMIN`|`EDITOR`|`VIEWER`

Returns:

  • (String)


234
235
236
237
238
239
240
241
# File 'lib/aws-sdk-managedgrafana/types.rb', line 234

class CreateWorkspaceApiKeyRequest < Struct.new(
  :key_name,
  :key_role,
  :seconds_to_live,
  :workspace_id)
  SENSITIVE = []
  include Aws::Structure
end

#seconds_to_liveInteger

Specifies the time in seconds until the key expires. Keys can be valid for up to 30 days.

Returns:

  • (Integer)


234
235
236
237
238
239
240
241
# File 'lib/aws-sdk-managedgrafana/types.rb', line 234

class CreateWorkspaceApiKeyRequest < Struct.new(
  :key_name,
  :key_role,
  :seconds_to_live,
  :workspace_id)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_idString

The ID of the workspace to create an API key.

Returns:

  • (String)


234
235
236
237
238
239
240
241
# File 'lib/aws-sdk-managedgrafana/types.rb', line 234

class CreateWorkspaceApiKeyRequest < Struct.new(
  :key_name,
  :key_role,
  :seconds_to_live,
  :workspace_id)
  SENSITIVE = []
  include Aws::Structure
end