Amazon CodeStar · JSON Structure

Codestar Associate Team Member Request Structure

AssociateTeamMemberRequest schema from AWS CodeStar API

Type: object Properties: 5 Required: 3
Developer ToolsDevOpsProject ManagementTeam Collaboration

AssociateTeamMemberRequest is a JSON Structure definition published by Amazon CodeStar, describing 5 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

projectId clientRequestToken userArn projectRole remoteAccessAllowed

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codestar/refs/heads/main/json-structure/codestar-associate-team-member-request-structure.json",
  "name": "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"
  ]
}