Struct aws_sdk_codebuild::input::CreateProjectInput

#[non_exhaustive]
pub struct CreateProjectInput {

    pub name: Option<String>,
    pub description: Option<String>,
    pub source: Option<ProjectSource>,
    pub secondary_sources: Option<Vec<ProjectSource>>,
    pub source_version: Option<String>,
    pub secondary_source_versions: Option<Vec<ProjectSourceVersion>>,
    pub artifacts: Option<ProjectArtifacts>,
    pub secondary_artifacts: Option<Vec<ProjectArtifacts>>,
    pub cache: Option<ProjectCache>,
    pub environment: Option<ProjectEnvironment>,
    pub service_role: Option<String>,
    pub timeout_in_minutes: Option<i32>,
    pub queued_timeout_in_minutes: Option<i32>,
    pub encryption_key: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub vpc_config: Option<VpcConfig>,
    pub badge_enabled: Option<bool>,
    pub logs_config: Option<LogsConfig>,
    pub file_system_locations: Option<Vec<ProjectFileSystemLocation>>,
    pub build_batch_config: Option<ProjectBuildBatchConfig>,
    pub concurrent_build_limit: Option<i32>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name of the build project.

description: Option<String>

A description that makes the build project easy to identify.

source: Option<ProjectSource>

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

secondary_sources: Option<Vec<ProjectSource>>

An array of ProjectSource objects.

source_version: Option<String>

A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:

• For CodeCommit: the commit ID, branch, or Git tag to use.

• For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

• For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

• For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).

For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.

secondary_source_versions: Option<Vec<ProjectSourceVersion>>

An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take precedence over these secondarySourceVersions (at the project level).

artifacts: Option<ProjectArtifacts>

Information about the build output artifacts for the build project.

secondary_artifacts: Option<Vec<ProjectArtifacts>>

An array of ProjectArtifacts objects.

cache: Option<ProjectCache>

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

environment: Option<ProjectEnvironment>

Information about the build environment for the build project.

service_role: Option<String>

The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.

timeout_in_minutes: Option<i32>

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

queued_timeout_in_minutes: Option<i32>

The number of minutes a build is allowed to be queued before it times out.

encryption_key: Option<String>

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

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

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

tags: Option<Vec<Tag>>

A list of tag key and value pairs associated with this build project.

These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.

vpc_config: Option<VpcConfig>

VpcConfig enables CodeBuild to access resources in an Amazon VPC.

badge_enabled: Option<bool>

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

logs_config: Option<LogsConfig>

Information about logs for the build project. These can be logs in CloudWatch Logs, logs uploaded to a specified S3 bucket, or both.

file_system_locations: Option<Vec<ProjectFileSystemLocation>>

An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.

build_batch_config: Option<ProjectBuildBatchConfig>

A ProjectBuildBatchConfig object that defines the batch build options for the project.

concurrent_build_limit: Option<i32>

The maximum number of concurrent builds that are allowed for this project.

New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.

Implementations

impl CreateProjectInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<CreateProject, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<CreateProject>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CreateProjectInput

impl CreateProjectInput

pub fn name(&self) -> Option<&str>

The name of the build project.

pub fn description(&self) -> Option<&str>

A description that makes the build project easy to identify.

pub fn source(&self) -> Option<&ProjectSource>

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

pub fn secondary_sources(&self) -> Option<&[ProjectSource]>

An array of ProjectSource objects.

pub fn source_version(&self) -> Option<&str>

A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:

• For CodeCommit: the commit ID, branch, or Git tag to use.

• For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

• For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

• For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).

For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.

pub fn secondary_source_versions(&self) -> Option<&[ProjectSourceVersion]>

An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take precedence over these secondarySourceVersions (at the project level).

pub fn artifacts(&self) -> Option<&ProjectArtifacts>

Information about the build output artifacts for the build project.

pub fn secondary_artifacts(&self) -> Option<&[ProjectArtifacts]>

An array of ProjectArtifacts objects.

pub fn cache(&self) -> Option<&ProjectCache>

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

pub fn environment(&self) -> Option<&ProjectEnvironment>

Information about the build environment for the build project.

pub fn service_role(&self) -> Option<&str>

The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.

pub fn timeout_in_minutes(&self) -> Option<i32>

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

pub fn queued_timeout_in_minutes(&self) -> Option<i32>

The number of minutes a build is allowed to be queued before it times out.

pub fn encryption_key(&self) -> Option<&str>

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

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

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

pub fn tags(&self) -> Option<&[Tag]>

A list of tag key and value pairs associated with this build project.

These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.

pub fn vpc_config(&self) -> Option<&VpcConfig>

VpcConfig enables CodeBuild to access resources in an Amazon VPC.

pub fn badge_enabled(&self) -> Option<bool>

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

pub fn logs_config(&self) -> Option<&LogsConfig>

Information about logs for the build project. These can be logs in CloudWatch Logs, logs uploaded to a specified S3 bucket, or both.

pub fn file_system_locations(&self) -> Option<&[ProjectFileSystemLocation]>

An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.

pub fn build_batch_config(&self) -> Option<&ProjectBuildBatchConfig>

A ProjectBuildBatchConfig object that defines the batch build options for the project.

pub fn concurrent_build_limit(&self) -> Option<i32>

The maximum number of concurrent builds that are allowed for this project.

New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.

Trait Implementations

impl Clone for CreateProjectInput

fn clone(&self) -> CreateProjectInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateProjectInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<CreateProjectInput> for CreateProjectInput

fn eq(&self, other: &CreateProjectInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CreateProjectInput) -> bool

This method tests for !=.

impl StructuralPartialEq for CreateProjectInput