You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::OpsWorks::Types::SetPermissionRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb

Overview

Note:

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

{
  stack_id: "String", # required
  iam_user_arn: "String", # required
  allow_ssh: false,
  allow_sudo: false,
  level: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#allow_sshBoolean

The user is allowed to use SSH to communicate with the instance.

Returns:

  • (Boolean)


5246
5247
5248
5249
5250
5251
5252
5253
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5246

class SetPermissionRequest < Struct.new(
  :stack_id,
  :iam_user_arn,
  :allow_ssh,
  :allow_sudo,
  :level)
  include Aws::Structure
end

#allow_sudoBoolean

The user is allowed to use sudo to elevate privileges.

Returns:

  • (Boolean)


5246
5247
5248
5249
5250
5251
5252
5253
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5246

class SetPermissionRequest < Struct.new(
  :stack_id,
  :iam_user_arn,
  :allow_ssh,
  :allow_sudo,
  :level)
  include Aws::Structure
end

#iam_user_arnString

The user's IAM ARN. This can also be a federated user's ARN.

Returns:

  • (String)


5246
5247
5248
5249
5250
5251
5252
5253
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5246

class SetPermissionRequest < Struct.new(
  :stack_id,
  :iam_user_arn,
  :allow_ssh,
  :allow_sudo,
  :level)
  include Aws::Structure
end

#levelString

The user's permission level, which must be set to one of the following strings. You cannot set your own permissions level.

  • deny

  • show

  • deploy

  • manage

  • iam_only

For more information on the permissions associated with these levels, see Managing User Permissions.

Returns:

  • (String)


5246
5247
5248
5249
5250
5251
5252
5253
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5246

class SetPermissionRequest < Struct.new(
  :stack_id,
  :iam_user_arn,
  :allow_ssh,
  :allow_sudo,
  :level)
  include Aws::Structure
end

#stack_idString

The stack ID.

Returns:

  • (String)


5246
5247
5248
5249
5250
5251
5252
5253
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5246

class SetPermissionRequest < Struct.new(
  :stack_id,
  :iam_user_arn,
  :allow_ssh,
  :allow_sudo,
  :level)
  include Aws::Structure
end