#[non_exhaustive]pub struct CreateProjectInput {Show 22 fields
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>,
pub auto_retry_limit: Option<i32>,
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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 examplepr/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 GitLab: the commit ID, branch, or Git tag to use.
-
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 2160 (36 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/
).
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.
If you're using compute fleets during project creation, do not provide vpcConfig.
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.
auto_retry_limit: Option<i32>
The maximum number of additional automatic retries after a failed build. For example, if the auto-retry limit is set to 2, CodeBuild will call the RetryBuild
API to automatically retry your build for up to 2 additional times.
Implementations§
Source§impl CreateProjectInput
impl CreateProjectInput
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A description that makes the build project easy to identify.
Sourcepub fn source(&self) -> Option<&ProjectSource>
pub fn source(&self) -> Option<&ProjectSource>
Information about the build input source code for the build project.
Sourcepub fn secondary_sources(&self) -> &[ProjectSource]
pub fn secondary_sources(&self) -> &[ProjectSource]
An array of ProjectSource
objects.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .secondary_sources.is_none()
.
Sourcepub fn source_version(&self) -> Option<&str>
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 examplepr/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 GitLab: the commit ID, branch, or Git tag to use.
-
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.
Sourcepub fn secondary_source_versions(&self) -> &[ProjectSourceVersion]
pub fn secondary_source_versions(&self) -> &[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).
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .secondary_source_versions.is_none()
.
Sourcepub fn artifacts(&self) -> Option<&ProjectArtifacts>
pub fn artifacts(&self) -> Option<&ProjectArtifacts>
Information about the build output artifacts for the build project.
Sourcepub fn secondary_artifacts(&self) -> &[ProjectArtifacts]
pub fn secondary_artifacts(&self) -> &[ProjectArtifacts]
An array of ProjectArtifacts
objects.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .secondary_artifacts.is_none()
.
Sourcepub fn cache(&self) -> Option<&ProjectCache>
pub fn cache(&self) -> Option<&ProjectCache>
Stores recently used information so that it can be quickly accessed at a later time.
Sourcepub fn environment(&self) -> Option<&ProjectEnvironment>
pub fn environment(&self) -> Option<&ProjectEnvironment>
Information about the build environment for the build project.
Sourcepub fn service_role(&self) -> Option<&str>
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.
Sourcepub fn timeout_in_minutes(&self) -> Option<i32>
pub fn timeout_in_minutes(&self) -> Option<i32>
How long, in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before it times out any build that has not been marked as completed. The default is 60 minutes.
Sourcepub fn queued_timeout_in_minutes(&self) -> Option<i32>
pub fn queued_timeout_in_minutes(&self) -> Option<i32>
The number of minutes a build is allowed to be queued before it times out.
Sourcepub fn encryption_key(&self) -> Option<&str>
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/
).
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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none()
.
Sourcepub fn vpc_config(&self) -> Option<&VpcConfig>
pub fn vpc_config(&self) -> Option<&VpcConfig>
VpcConfig enables CodeBuild to access resources in an Amazon VPC.
If you're using compute fleets during project creation, do not provide vpcConfig.
Sourcepub fn badge_enabled(&self) -> Option<bool>
pub fn badge_enabled(&self) -> Option<bool>
Set this to true to generate a publicly accessible URL for your project's build badge.
Sourcepub fn logs_config(&self) -> Option<&LogsConfig>
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.
Sourcepub fn file_system_locations(&self) -> &[ProjectFileSystemLocation]
pub fn file_system_locations(&self) -> &[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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .file_system_locations.is_none()
.
Sourcepub fn build_batch_config(&self) -> Option<&ProjectBuildBatchConfig>
pub fn build_batch_config(&self) -> Option<&ProjectBuildBatchConfig>
A ProjectBuildBatchConfig
object that defines the batch build options for the project.
Sourcepub fn concurrent_build_limit(&self) -> Option<i32>
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.
Sourcepub fn auto_retry_limit(&self) -> Option<i32>
pub fn auto_retry_limit(&self) -> Option<i32>
The maximum number of additional automatic retries after a failed build. For example, if the auto-retry limit is set to 2, CodeBuild will call the RetryBuild
API to automatically retry your build for up to 2 additional times.
Source§impl CreateProjectInput
impl CreateProjectInput
Sourcepub fn builder() -> CreateProjectInputBuilder
pub fn builder() -> CreateProjectInputBuilder
Creates a new builder-style object to manufacture CreateProjectInput
.
Trait Implementations§
Source§impl Clone for CreateProjectInput
impl Clone for CreateProjectInput
Source§fn clone(&self) -> CreateProjectInput
fn clone(&self) -> CreateProjectInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CreateProjectInput
impl Debug for CreateProjectInput
Source§impl PartialEq for CreateProjectInput
impl PartialEq for CreateProjectInput
impl StructuralPartialEq for CreateProjectInput
Auto Trait Implementations§
impl Freeze for CreateProjectInput
impl RefUnwindSafe for CreateProjectInput
impl Send for CreateProjectInput
impl Sync for CreateProjectInput
impl Unpin for CreateProjectInput
impl UnwindSafe for CreateProjectInput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);