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

Class: Aws::CodeStar::Types::UpdateTeamMemberRequest

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

Overview

Note:

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

{
  project_id: "ProjectId", # required
  user_arn: "UserArn", # required
  project_role: "Role",
  remote_access_allowed: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#project_id ⇒ String

The ID of the project.

Returns:

  • (String) 


893
894
895
896
897
898
899
 
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/types.rb', line 893

class UpdateTeamMemberRequest < Struct.new(
  :project_id,
  :user_arn,
  :project_role,
  :remote_access_allowed)
  include Aws::Structure
end

#project_role ⇒ String

The role assigned to the user in the project. Project roles have different levels of access. For more information, see Working with Teams in the AWS CodeStar User Guide.

Returns:

  • (String) 


893
894
895
896
897
898
899
 
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/types.rb', line 893

class UpdateTeamMemberRequest < Struct.new(
  :project_id,
  :user_arn,
  :project_role,
  :remote_access_allowed)
  include Aws::Structure
end

#remote_access_allowed ⇒ Boolean

Whether a team member is allowed to remotely access project resources using the SSH public key associated with the user's profile. Even if this is set to True, the user must associate a public key with their profile before the user can access resources.

Returns:

  • (Boolean) 


893
894
895
896
897
898
899
 
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/types.rb', line 893

class UpdateTeamMemberRequest < Struct.new(
  :project_id,
  :user_arn,
  :project_role,
  :remote_access_allowed)
  include Aws::Structure
end

#user_arn ⇒ String

The Amazon Resource Name (ARN) of the user for whom you want to change team membership attributes.

Returns:

  • (String) 


893
894
895
896
897
898
899
 
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/types.rb', line 893

class UpdateTeamMemberRequest < Struct.new(
  :project_id,
  :user_arn,
  :project_role,
  :remote_access_allowed)
  include Aws::Structure
end