You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CodeBuild::Types::CreateProjectInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb

Overview

Note:

When making an API call, you may pass CreateProjectInput data as a hash:

{
  name: "ProjectName", # required
  description: "ProjectDescription",
  source: { # required
    type: "CODECOMMIT", # required, accepts CODECOMMIT, CODEPIPELINE, GITHUB, S3, BITBUCKET, GITHUB_ENTERPRISE
    location: "String",
    git_clone_depth: 1,
    buildspec: "String",
    auth: {
      type: "OAUTH", # required, accepts OAUTH
      resource: "String",
    },
    report_build_status: false,
    insecure_ssl: false,
  },
  artifacts: { # required
    type: "CODEPIPELINE", # required, accepts CODEPIPELINE, S3, NO_ARTIFACTS
    location: "String",
    path: "String",
    namespace_type: "NONE", # accepts NONE, BUILD_ID
    name: "String",
    packaging: "NONE", # accepts NONE, ZIP
    override_artifact_name: false,
    encryption_disabled: false,
  },
  cache: {
    type: "NO_CACHE", # required, accepts NO_CACHE, S3
    location: "String",
  },
  environment: { # required
    type: "WINDOWS_CONTAINER", # required, accepts WINDOWS_CONTAINER, LINUX_CONTAINER
    image: "NonEmptyString", # required
    compute_type: "BUILD_GENERAL1_SMALL", # required, accepts BUILD_GENERAL1_SMALL, BUILD_GENERAL1_MEDIUM, BUILD_GENERAL1_LARGE
    environment_variables: [
      {
        name: "NonEmptyString", # required
        value: "String", # required
        type: "PLAINTEXT", # accepts PLAINTEXT, PARAMETER_STORE
      },
    ],
    privileged_mode: false,
    certificate: "String",
  },
  service_role: "NonEmptyString", # required
  timeout_in_minutes: 1,
  encryption_key: "NonEmptyString",
  tags: [
    {
      key: "KeyInput",
      value: "ValueInput",
    },
  ],
  vpc_config: {
    vpc_id: "NonEmptyString",
    subnets: ["NonEmptyString"],
    security_group_ids: ["NonEmptyString"],
  },
  badge_enabled: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#artifactsTypes::ProjectArtifacts

Information about the build output artifacts for the build project.



539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 539

class CreateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled)
  include Aws::Structure
end

#badge_enabledBoolean

Set this to true to generate a publicly-accessible URL for your project's build badge.

Returns:

  • (Boolean)


539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 539

class CreateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled)
  include Aws::Structure
end

#cacheTypes::ProjectCache

Stores recently used information so that it can be quickly accessed at a later time.

Returns:



539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 539

class CreateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled)
  include Aws::Structure
end

#descriptionString

A description that makes the build project easy to identify.

Returns:

  • (String)


539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 539

class CreateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled)
  include Aws::Structure
end

#encryption_keyString

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.

You can specify either the CMK's Amazon Resource Name (ARN) or, if available, the CMK's alias (using the format alias/alias-name).

Returns:

  • (String)


539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 539

class CreateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled)
  include Aws::Structure
end

#environmentTypes::ProjectEnvironment

Information about the build environment for the build project.



539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 539

class CreateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled)
  include Aws::Structure
end

#nameString

The name of the build project.

Returns:

  • (String)


539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 539

class CreateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled)
  include Aws::Structure
end

#service_roleString

The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

Returns:

  • (String)


539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 539

class CreateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled)
  include Aws::Structure
end

#sourceTypes::ProjectSource

Information about the build input source code for the build project.



539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 539

class CreateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled)
  include Aws::Structure
end

#tagsArray<Types::Tag>

A set of tags for this build project.

These tags are available for use by AWS services that support AWS CodeBuild build project tags.

Returns:



539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 539

class CreateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled)
  include Aws::Structure
end

#timeout_in_minutesInteger

How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any build that has not been marked as completed. The default is 60 minutes.

Returns:

  • (Integer)


539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 539

class CreateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled)
  include Aws::Structure
end

#vpc_configTypes::VpcConfig

VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC.

Returns:



539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 539

class CreateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled)
  include Aws::Structure
end