Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . codestar ]

create-project

Description

Creates a project, including project resources. This action creates a project based on a submitted project request. A set of source code files and a toolchain template file can be included with the project request. If these are not provided, an empty project is created.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-project
--name <value>
--id <value>
[--description <value>]
[--client-request-token <value>]
[--source-code <value>]
[--toolchain <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--name (string)

The display name for the project to be created in AWS CodeStar.

--id (string)

The ID of the project to be created in AWS CodeStar.

--description (string)

The description of the project, if any.

--client-request-token (string)

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

--source-code (list)

A list of the Code objects submitted with the project request. If this parameter is specified, the request must also include the toolchain parameter.

Shorthand Syntax:

source={s3={bucketName=string,bucketKey=string}},destination={codeCommit={name=string},gitHub={name=string,description=string,type=string,owner=string,privateRepository=boolean,issuesEnabled=boolean,token=string}} ...

JSON Syntax:

[
  {
    "source": {
      "s3": {
        "bucketName": "string",
        "bucketKey": "string"
      }
    },
    "destination": {
      "codeCommit": {
        "name": "string"
      },
      "gitHub": {
        "name": "string",
        "description": "string",
        "type": "string",
        "owner": "string",
        "privateRepository": true|false,
        "issuesEnabled": true|false,
        "token": "string"
      }
    }
  }
  ...
]

--toolchain (structure)

The name of the toolchain template file submitted with the project request. If this parameter is specified, the request must also include the sourceCode parameter.

Shorthand Syntax:

source={s3={bucketName=string,bucketKey=string}},roleArn=string,stackParameters={KeyName1=string,KeyName2=string}

JSON Syntax:

{
  "source": {
    "s3": {
      "bucketName": "string",
      "bucketKey": "string"
    }
  },
  "roleArn": "string",
  "stackParameters": {"string": "string"
    ...}
}

--tags (map)

The tags created for the project.

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To create a project

The following create-project example uses a JSON input file to create a CodeStar project.

aws codestar create-project \
    --cli-input-json file://create-project.json

Contents of create-project.json:

{
    "name": "Custom Project",
    "id": "custom-project",
    "sourceCode": [
        {
            "source": {
                "s3": {
                    "bucketName": "codestar-artifacts",
                    "bucketKey": "nodejs-function.zip"
                }
            },
            "destination": {
                "codeCommit": {
                    "name": "codestar-custom-project"
                }
            }
        }
    ],
    "toolchain": {
        "source": {
            "s3": {
                "bucketName": "codestar-artifacts",
                "bucketKey": "toolchain.yml"
            }
        },
        "roleArn": "arn:aws:iam::123456789012:role/service-role/aws-codestar-service-role",
        "stackParameters": {
            "ProjectId": "custom-project"
        }
    }
}

Output:

{
    "id": "my-project",
    "arn": "arn:aws:codestar:us-east-2:123456789012:project/custom-project"
}

For a tutorial that includes sample code and templates for a custom project, see `Create a Project in AWS CodeStar with the AWS CLI<https://docs.aws.amazon.com/codestar/latest/userguide/cli-tutorial.html>`__ in the AWS CodeStar User Guide.

Output

id -> (string)

The ID of the project.

arn -> (string)

The Amazon Resource Name (ARN) of the created project.

clientRequestToken -> (string)

A user- or system-generated token that identifies the entity that requested project creation.

projectTemplateId -> (string)

Reserved for future use.