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

Class: Aws::CodeStar::Types::AssociateTeamMemberRequest

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 AssociateTeamMemberRequest data as a hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

A user- or system-generated token that identifies the entity that requested the team member association to the project. This token can be used to repeat the request.

Returns:

  • (String)


51
52
53
54
55
56
57
58
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/types.rb', line 51

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

#project_idString

The ID of the project to which you will add the IAM user.

Returns:

  • (String)


51
52
53
54
55
56
57
58
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/types.rb', line 51

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

#project_roleString

The AWS CodeStar project role that will apply to this user. This role determines what actions a user can take in an AWS CodeStar project.

Returns:

  • (String)


51
52
53
54
55
56
57
58
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/types.rb', line 51

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

#remote_access_allowedBoolean

Whether the team member is allowed to use an SSH public/private key pair to remotely access project resources, for example Amazon EC2 instances.

Returns:

  • (Boolean)


51
52
53
54
55
56
57
58
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/types.rb', line 51

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

#user_arnString

The Amazon Resource Name (ARN) for the IAM user you want to add to the AWS CodeStar project.

Returns:

  • (String)


51
52
53
54
55
56
57
58
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/types.rb', line 51

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