Amazon CodeStar · Schema

AssociateTeamMemberRequest

AssociateTeamMemberRequest schema from AWS CodeStar API

Developer ToolsDevOpsProject ManagementTeam Collaboration

Properties

Name Type Description
projectId object
clientRequestToken object
userArn object
projectRole object
remoteAccessAllowed object
View JSON Schema on GitHub

JSON Schema

codestar-associate-team-member-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codestar/refs/heads/main/json-schema/codestar-associate-team-member-request-schema.json",
  "title": "AssociateTeamMemberRequest",
  "description": "AssociateTeamMemberRequest schema from AWS CodeStar API",
  "type": "object",
  "properties": {
    "projectId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProjectId"
        },
        {
          "description": "The ID of the project to which you will add the IAM user."
        }
      ]
    },
    "clientRequestToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientRequestToken"
        },
        {
          "description": "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."
        }
      ]
    },
    "userArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) for the IAM user you want to add to the AWS CodeStar project."
        }
      ]
    },
    "projectRole": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Role"
        },
        {
          "description": "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."
        }
      ]
    },
    "remoteAccessAllowed": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RemoteAccessAllowed"
        },
        {
          "description": "Whether the team member is allowed to use an SSH public/private key pair to remotely access project resources, for example Amazon EC2 instances."
        }
      ]
    }
  },
  "required": [
    "projectId",
    "userArn",
    "projectRole"
  ]
}