Class: Aws::ElastiCache::Types::ModifyUserMessage

Inherits:

Struct

• Object
• Struct
• Aws::ElastiCache::Types::ModifyUserMessage

Includes:

Structure

Defined in:

lib/aws-sdk-elasticache/types.rb

Overview

Note:

When making an API call, you may pass ModifyUserMessage data as a hash:

{
  user_id: "UserId", # required
  access_string: "AccessString",
  append_access_string: "AccessString",
  passwords: ["String"],
  no_password_required: false,
  authentication_mode: {
    type: "password", # accepts password, no-password-required, iam
    passwords: ["String"],
  },
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #access_string ⇒ String

  Access permissions string used for this user.

• #append_access_string ⇒ String

  Adds additional user permissions to the access string.

• #authentication_mode ⇒ Types::AuthenticationMode

  Specifies how to authenticate the user.

• #no_password_required ⇒ Boolean

  Indicates no password is required for the user.

• #passwords ⇒ Array<String>

  The passwords belonging to the user.

• #user_id ⇒ String

  The ID of the user.

Instance Attribute Details

#access_string ⇒ String

Access permissions string used for this user.

# File 'lib/aws-sdk-elasticache/types.rb', line 7054

class ModifyUserMessage < Struct.new(
  :user_id,
  :access_string,
  :append_access_string,
  :passwords,
  :no_password_required,
  :authentication_mode)
  SENSITIVE = []
  include Aws::Structure
end

#append_access_string ⇒ String

Adds additional user permissions to the access string.

# File 'lib/aws-sdk-elasticache/types.rb', line 7054

class ModifyUserMessage < Struct.new(
  :user_id,
  :access_string,
  :append_access_string,
  :passwords,
  :no_password_required,
  :authentication_mode)
  SENSITIVE = []
  include Aws::Structure
end

#authentication_mode ⇒ Types::AuthenticationMode

Specifies how to authenticate the user.

# File 'lib/aws-sdk-elasticache/types.rb', line 7054

class ModifyUserMessage < Struct.new(
  :user_id,
  :access_string,
  :append_access_string,
  :passwords,
  :no_password_required,
  :authentication_mode)
  SENSITIVE = []
  include Aws::Structure
end

#no_password_required ⇒ Boolean

Indicates no password is required for the user.

# File 'lib/aws-sdk-elasticache/types.rb', line 7054

class ModifyUserMessage < Struct.new(
  :user_id,
  :access_string,
  :append_access_string,
  :passwords,
  :no_password_required,
  :authentication_mode)
  SENSITIVE = []
  include Aws::Structure
end

#passwords ⇒ Array<String>

The passwords belonging to the user. You are allowed up to two.

# File 'lib/aws-sdk-elasticache/types.rb', line 7054

class ModifyUserMessage < Struct.new(
  :user_id,
  :access_string,
  :append_access_string,
  :passwords,
  :no_password_required,
  :authentication_mode)
  SENSITIVE = []
  include Aws::Structure
end

#user_id ⇒ String

The ID of the user.

# File 'lib/aws-sdk-elasticache/types.rb', line 7054

class ModifyUserMessage < Struct.new(
  :user_id,
  :access_string,
  :append_access_string,
  :passwords,
  :no_password_required,
  :authentication_mode)
  SENSITIVE = []
  include Aws::Structure
end