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.

Synopsis¶

  create-project
--name <value>
--id <value>
[--description <value>]
[--client-request-token <value>]
[--source-code <value>]
[--toolchain <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <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.

(structure)

Location and destination information about the source code files provided with the project request. The source code is uploaded to the new project source repository after project creation.

source -> (structure)

The location where the source code files provided with the project request are stored. AWS CodeStar retrieves the files during project creation.

s3 -> (structure)

Information about the Amazon S3 location where the source code files provided with the project request are stored.

bucketName -> (string)

The Amazon S3 bucket name where the source code files provided with the project request are stored.

bucketKey -> (string)

The Amazon S3 object key where the source code files provided with the project request are stored.

destination -> (structure)

The repository to be created in AWS CodeStar. Valid values are AWS CodeCommit or GitHub. After AWS CodeStar provisions the new repository, the source code files provided with the project request are placed in the repository.

codeCommit -> (structure)

Information about the AWS CodeCommit repository to be created in AWS CodeStar. This is where the source code files provided with the project request will be uploaded after project creation.

name -> (string)

The name of the AWS CodeCommit repository to be created in AWS CodeStar.

gitHub -> (structure)

Information about the GitHub repository to be created in AWS CodeStar. This is where the source code files provided with the project request will be uploaded after project creation.

name -> (string)

Name of the GitHub repository to be created in AWS CodeStar.

description -> (string)

Description for the GitHub repository to be created in AWS CodeStar. This description displays in GitHub after the repository is created.

type -> (string)

The type of GitHub repository to be created in AWS CodeStar. Valid values are User or Organization.

owner -> (string)

The GitHub username for the owner of the GitHub repository to be created in AWS CodeStar. If this repository should be owned by a GitHub organization, provide its name.

privateRepository -> (boolean)

Whether the GitHub repository is to be a private repository.

issuesEnabled -> (boolean)

Whether to enable issues for the GitHub repository.

token -> (string)

The GitHub user’s personal access token for the GitHub repository.

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.

source -> (structure)

The Amazon S3 location where the toolchain template file provided with the project request is stored. AWS CodeStar retrieves the file during project creation.

s3 -> (structure)

The Amazon S3 bucket where the toolchain template file provided with the project request is stored.

bucketName -> (string)

The Amazon S3 bucket name where the source code files provided with the project request are stored.

bucketKey -> (string)

The Amazon S3 object key where the source code files provided with the project request are stored.

roleArn -> (string)

The service role ARN for AWS CodeStar to use for the toolchain template during stack provisioning.

stackParameters -> (map)

The list of parameter overrides to be passed into the toolchain template during stack provisioning, if any.

key -> (string)

value -> (string)

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.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

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.

Table of Contents

Feedback

User Guide

create-project¶

Description¶

Synopsis¶

Options¶

Examples¶

Output¶