Class: Aws::CodeStar::Types::CreateProjectRequest

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

{
  name: "ProjectName", # required
  id: "ProjectId", # required
  description: "ProjectDescription",
  client_request_token: "ClientRequestToken",
  source_code: [
    {
      source: { # required
        s3: { # required
          bucket_name: "BucketName",
          bucket_key: "BucketKey",
        },
      },
      destination: { # required
        code_commit: {
          name: "RepositoryName", # required
        },
        git_hub: {
          name: "RepositoryName", # required
          description: "RepositoryDescription",
          type: "RepositoryType", # required
          owner: "RepositoryOwner", # required
          private_repository: false, # required
          issues_enabled: false, # required
          token: "GitHubPersonalToken", # required
        },
      },
    },
  ],
  toolchain: {
    source: { # required
      s3: { # required
        bucket_name: "BucketName",
        bucket_key: "BucketKey",
      },
    },
    role_arn: "RoleArn",
    stack_parameters: {
      "TemplateParameterKey" => "TemplateParameterValue",
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
}

Constant Summary collapse

SENSITIVE =
[:name, :description]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

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

Returns:

  • (String)


315
316
317
318
319
320
321
322
323
324
325
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/types.rb', line 315

class CreateProjectRequest < Struct.new(
  :name,
  :id,
  :description,
  :client_request_token,
  :source_code,
  :toolchain,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#descriptionString

The description of the project, if any.

Returns:

  • (String)


315
316
317
318
319
320
321
322
323
324
325
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/types.rb', line 315

class CreateProjectRequest < Struct.new(
  :name,
  :id,
  :description,
  :client_request_token,
  :source_code,
  :toolchain,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#idString

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

Returns:

  • (String)


315
316
317
318
319
320
321
322
323
324
325
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/types.rb', line 315

class CreateProjectRequest < Struct.new(
  :name,
  :id,
  :description,
  :client_request_token,
  :source_code,
  :toolchain,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#nameString

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

Returns:

  • (String)


315
316
317
318
319
320
321
322
323
324
325
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/types.rb', line 315

class CreateProjectRequest < Struct.new(
  :name,
  :id,
  :description,
  :client_request_token,
  :source_code,
  :toolchain,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#source_codeArray<Types::Code>

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

Returns:



315
316
317
318
319
320
321
322
323
324
325
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/types.rb', line 315

class CreateProjectRequest < Struct.new(
  :name,
  :id,
  :description,
  :client_request_token,
  :source_code,
  :toolchain,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#tagsHash<String,String>

The tags created for the project.

Returns:

  • (Hash<String,String>)


315
316
317
318
319
320
321
322
323
324
325
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/types.rb', line 315

class CreateProjectRequest < Struct.new(
  :name,
  :id,
  :description,
  :client_request_token,
  :source_code,
  :toolchain,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#toolchainTypes::Toolchain

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.

Returns:



315
316
317
318
319
320
321
322
323
324
325
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/types.rb', line 315

class CreateProjectRequest < Struct.new(
  :name,
  :id,
  :description,
  :client_request_token,
  :source_code,
  :toolchain,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end