pub struct CreateJobTemplateFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateJobTemplate
.
Creates a job template.
Requires permission to access the CreateJobTemplate action.
Implementations§
Source§impl CreateJobTemplateFluentBuilder
impl CreateJobTemplateFluentBuilder
Sourcepub fn as_input(&self) -> &CreateJobTemplateInputBuilder
pub fn as_input(&self) -> &CreateJobTemplateInputBuilder
Access the CreateJobTemplate as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateJobTemplateOutput, SdkError<CreateJobTemplateError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateJobTemplateOutput, SdkError<CreateJobTemplateError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateJobTemplateOutput, CreateJobTemplateError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateJobTemplateOutput, CreateJobTemplateError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn job_template_id(self, input: impl Into<String>) -> Self
pub fn job_template_id(self, input: impl Into<String>) -> Self
A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.
Sourcepub fn set_job_template_id(self, input: Option<String>) -> Self
pub fn set_job_template_id(self, input: Option<String>) -> Self
A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.
Sourcepub fn get_job_template_id(&self) -> &Option<String>
pub fn get_job_template_id(&self) -> &Option<String>
A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.
Sourcepub fn job_arn(self, input: impl Into<String>) -> Self
pub fn job_arn(self, input: impl Into<String>) -> Self
The ARN of the job to use as the basis for the job template.
Sourcepub fn set_job_arn(self, input: Option<String>) -> Self
pub fn set_job_arn(self, input: Option<String>) -> Self
The ARN of the job to use as the basis for the job template.
Sourcepub fn get_job_arn(&self) -> &Option<String>
pub fn get_job_arn(&self) -> &Option<String>
The ARN of the job to use as the basis for the job template.
Sourcepub fn document_source(self, input: impl Into<String>) -> Self
pub fn document_source(self, input: impl Into<String>) -> Self
An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document
.
For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0
For more information, see Methods for accessing a bucket.
Sourcepub fn set_document_source(self, input: Option<String>) -> Self
pub fn set_document_source(self, input: Option<String>) -> Self
An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document
.
For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0
For more information, see Methods for accessing a bucket.
Sourcepub fn get_document_source(&self) -> &Option<String>
pub fn get_document_source(&self) -> &Option<String>
An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document
.
For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0
For more information, see Methods for accessing a bucket.
Sourcepub fn document(self, input: impl Into<String>) -> Self
pub fn document(self, input: impl Into<String>) -> Self
The job document. Required if you don't specify a value for documentSource
.
Sourcepub fn set_document(self, input: Option<String>) -> Self
pub fn set_document(self, input: Option<String>) -> Self
The job document. Required if you don't specify a value for documentSource
.
Sourcepub fn get_document(&self) -> &Option<String>
pub fn get_document(&self) -> &Option<String>
The job document. Required if you don't specify a value for documentSource
.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description of the job document.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description of the job document.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description of the job document.
Sourcepub fn presigned_url_config(self, input: PresignedUrlConfig) -> Self
pub fn presigned_url_config(self, input: PresignedUrlConfig) -> Self
Configuration for pre-signed S3 URLs.
Sourcepub fn set_presigned_url_config(self, input: Option<PresignedUrlConfig>) -> Self
pub fn set_presigned_url_config(self, input: Option<PresignedUrlConfig>) -> Self
Configuration for pre-signed S3 URLs.
Sourcepub fn get_presigned_url_config(&self) -> &Option<PresignedUrlConfig>
pub fn get_presigned_url_config(&self) -> &Option<PresignedUrlConfig>
Configuration for pre-signed S3 URLs.
Sourcepub fn job_executions_rollout_config(
self,
input: JobExecutionsRolloutConfig,
) -> Self
pub fn job_executions_rollout_config( self, input: JobExecutionsRolloutConfig, ) -> Self
Allows you to create a staged rollout of a job.
Sourcepub fn set_job_executions_rollout_config(
self,
input: Option<JobExecutionsRolloutConfig>,
) -> Self
pub fn set_job_executions_rollout_config( self, input: Option<JobExecutionsRolloutConfig>, ) -> Self
Allows you to create a staged rollout of a job.
Sourcepub fn get_job_executions_rollout_config(
&self,
) -> &Option<JobExecutionsRolloutConfig>
pub fn get_job_executions_rollout_config( &self, ) -> &Option<JobExecutionsRolloutConfig>
Allows you to create a staged rollout of a job.
Sourcepub fn abort_config(self, input: AbortConfig) -> Self
pub fn abort_config(self, input: AbortConfig) -> Self
The criteria that determine when and how a job abort takes place.
Sourcepub fn set_abort_config(self, input: Option<AbortConfig>) -> Self
pub fn set_abort_config(self, input: Option<AbortConfig>) -> Self
The criteria that determine when and how a job abort takes place.
Sourcepub fn get_abort_config(&self) -> &Option<AbortConfig>
pub fn get_abort_config(&self) -> &Option<AbortConfig>
The criteria that determine when and how a job abort takes place.
Sourcepub fn timeout_config(self, input: TimeoutConfig) -> Self
pub fn timeout_config(self, input: TimeoutConfig) -> Self
Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS
. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT
.
Sourcepub fn set_timeout_config(self, input: Option<TimeoutConfig>) -> Self
pub fn set_timeout_config(self, input: Option<TimeoutConfig>) -> Self
Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS
. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT
.
Sourcepub fn get_timeout_config(&self) -> &Option<TimeoutConfig>
pub fn get_timeout_config(&self) -> &Option<TimeoutConfig>
Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS
. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT
.
Appends an item to tags
.
To override the contents of this collection use set_tags
.
Metadata that can be used to manage the job template.
Metadata that can be used to manage the job template.
Metadata that can be used to manage the job template.
Sourcepub fn job_executions_retry_config(
self,
input: JobExecutionsRetryConfig,
) -> Self
pub fn job_executions_retry_config( self, input: JobExecutionsRetryConfig, ) -> Self
Allows you to create the criteria to retry a job.
Sourcepub fn set_job_executions_retry_config(
self,
input: Option<JobExecutionsRetryConfig>,
) -> Self
pub fn set_job_executions_retry_config( self, input: Option<JobExecutionsRetryConfig>, ) -> Self
Allows you to create the criteria to retry a job.
Sourcepub fn get_job_executions_retry_config(
&self,
) -> &Option<JobExecutionsRetryConfig>
pub fn get_job_executions_retry_config( &self, ) -> &Option<JobExecutionsRetryConfig>
Allows you to create the criteria to retry a job.
Sourcepub fn maintenance_windows(self, input: MaintenanceWindow) -> Self
pub fn maintenance_windows(self, input: MaintenanceWindow) -> Self
Appends an item to maintenanceWindows
.
To override the contents of this collection use set_maintenance_windows
.
Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.
Sourcepub fn set_maintenance_windows(
self,
input: Option<Vec<MaintenanceWindow>>,
) -> Self
pub fn set_maintenance_windows( self, input: Option<Vec<MaintenanceWindow>>, ) -> Self
Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.
Sourcepub fn get_maintenance_windows(&self) -> &Option<Vec<MaintenanceWindow>>
pub fn get_maintenance_windows(&self) -> &Option<Vec<MaintenanceWindow>>
Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.
Sourcepub fn destination_package_versions(self, input: impl Into<String>) -> Self
pub fn destination_package_versions(self, input: impl Into<String>) -> Self
Appends an item to destinationPackageVersions
.
To override the contents of this collection use set_destination_package_versions
.
The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.
Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.
Sourcepub fn set_destination_package_versions(
self,
input: Option<Vec<String>>,
) -> Self
pub fn set_destination_package_versions( self, input: Option<Vec<String>>, ) -> Self
The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.
Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.
Sourcepub fn get_destination_package_versions(&self) -> &Option<Vec<String>>
pub fn get_destination_package_versions(&self) -> &Option<Vec<String>>
The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.
Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.
Trait Implementations§
Source§impl Clone for CreateJobTemplateFluentBuilder
impl Clone for CreateJobTemplateFluentBuilder
Source§fn clone(&self) -> CreateJobTemplateFluentBuilder
fn clone(&self) -> CreateJobTemplateFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CreateJobTemplateFluentBuilder
impl !RefUnwindSafe for CreateJobTemplateFluentBuilder
impl Send for CreateJobTemplateFluentBuilder
impl Sync for CreateJobTemplateFluentBuilder
impl Unpin for CreateJobTemplateFluentBuilder
impl !UnwindSafe for CreateJobTemplateFluentBuilder
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);