pub struct CreateApplicationFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateApplication
.
Creates an application resource in Amazon GameLift Streams, which specifies the application content you want to stream, such as a game build or other software, and configures the settings to run it.
Before you create an application, upload your application content files to an Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Getting Started in the Amazon GameLift Streams Developer Guide.
Make sure that your files in the Amazon S3 bucket are the correct version you want to use. If you change the files at a later time, you will need to create a new Amazon GameLift Streams application.
If the request is successful, Amazon GameLift Streams begins to create an application and sets the status to INITIALIZED
. When an application reaches READY
status, you can use the application to set up stream groups and start streams. To track application status, call GetApplication.
Implementations§
Source§impl CreateApplicationFluentBuilder
impl CreateApplicationFluentBuilder
Sourcepub fn as_input(&self) -> &CreateApplicationInputBuilder
pub fn as_input(&self) -> &CreateApplicationInputBuilder
Access the CreateApplication as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateApplicationOutput, SdkError<CreateApplicationError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateApplicationOutput, SdkError<CreateApplicationError, 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<CreateApplicationOutput, CreateApplicationError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateApplicationOutput, CreateApplicationError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A human-readable label for the application. You can update this value later.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A human-readable label for the application. You can update this value later.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A human-readable label for the application. You can update this value later.
Sourcepub fn runtime_environment(self, input: RuntimeEnvironment) -> Self
pub fn runtime_environment(self, input: RuntimeEnvironment) -> Self
Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers.
A runtime environment can be one of the following:
-
For Linux applications
-
Ubuntu 22.04 LTS (
Type=UBUNTU, Version=22_04_LTS
)
-
-
For Windows applications
-
Microsoft Windows Server 2022 Base (
Type=WINDOWS, Version=2022
) -
Proton 8.0-5 (
Type=PROTON, Version=20241007
) -
Proton 8.0-2c (
Type=PROTON, Version=20230704
)
-
Sourcepub fn set_runtime_environment(self, input: Option<RuntimeEnvironment>) -> Self
pub fn set_runtime_environment(self, input: Option<RuntimeEnvironment>) -> Self
Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers.
A runtime environment can be one of the following:
-
For Linux applications
-
Ubuntu 22.04 LTS (
Type=UBUNTU, Version=22_04_LTS
)
-
-
For Windows applications
-
Microsoft Windows Server 2022 Base (
Type=WINDOWS, Version=2022
) -
Proton 8.0-5 (
Type=PROTON, Version=20241007
) -
Proton 8.0-2c (
Type=PROTON, Version=20230704
)
-
Sourcepub fn get_runtime_environment(&self) -> &Option<RuntimeEnvironment>
pub fn get_runtime_environment(&self) -> &Option<RuntimeEnvironment>
Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers.
A runtime environment can be one of the following:
-
For Linux applications
-
Ubuntu 22.04 LTS (
Type=UBUNTU, Version=22_04_LTS
)
-
-
For Windows applications
-
Microsoft Windows Server 2022 Base (
Type=WINDOWS, Version=2022
) -
Proton 8.0-5 (
Type=PROTON, Version=20241007
) -
Proton 8.0-2c (
Type=PROTON, Version=20230704
)
-
Sourcepub fn executable_path(self, input: impl Into<String>) -> Self
pub fn executable_path(self, input: impl Into<String>) -> Self
The path and file name of the executable file that launches the content for streaming. Enter a path value that is relative to the location set in ApplicationSourceUri
.
Sourcepub fn set_executable_path(self, input: Option<String>) -> Self
pub fn set_executable_path(self, input: Option<String>) -> Self
The path and file name of the executable file that launches the content for streaming. Enter a path value that is relative to the location set in ApplicationSourceUri
.
Sourcepub fn get_executable_path(&self) -> &Option<String>
pub fn get_executable_path(&self) -> &Option<String>
The path and file name of the executable file that launches the content for streaming. Enter a path value that is relative to the location set in ApplicationSourceUri
.
Sourcepub fn application_source_uri(self, input: impl Into<String>) -> Self
pub fn application_source_uri(self, input: impl Into<String>) -> Self
The location of the content that you want to stream. Enter an Amazon S3 URI to a bucket that contains your game or other application. The location can have a multi-level prefix structure, but it must include all the files needed to run the content. Amazon GameLift Streams copies everything under the specified location.
This value is immutable. To designate a different content location, create a new application.
The Amazon S3 bucket and the Amazon GameLift Streams application must be in the same Amazon Web Services Region.
Sourcepub fn set_application_source_uri(self, input: Option<String>) -> Self
pub fn set_application_source_uri(self, input: Option<String>) -> Self
The location of the content that you want to stream. Enter an Amazon S3 URI to a bucket that contains your game or other application. The location can have a multi-level prefix structure, but it must include all the files needed to run the content. Amazon GameLift Streams copies everything under the specified location.
This value is immutable. To designate a different content location, create a new application.
The Amazon S3 bucket and the Amazon GameLift Streams application must be in the same Amazon Web Services Region.
Sourcepub fn get_application_source_uri(&self) -> &Option<String>
pub fn get_application_source_uri(&self) -> &Option<String>
The location of the content that you want to stream. Enter an Amazon S3 URI to a bucket that contains your game or other application. The location can have a multi-level prefix structure, but it must include all the files needed to run the content. Amazon GameLift Streams copies everything under the specified location.
This value is immutable. To designate a different content location, create a new application.
The Amazon S3 bucket and the Amazon GameLift Streams application must be in the same Amazon Web Services Region.
Sourcepub fn application_log_paths(self, input: impl Into<String>) -> Self
pub fn application_log_paths(self, input: impl Into<String>) -> Self
Appends an item to ApplicationLogPaths
.
To override the contents of this collection use set_application_log_paths
.
Locations of log files that your content generates during a stream session. Enter path values that are relative to the ApplicationSourceUri
location. You can specify up to 10 log paths. Amazon GameLift Streams uploads designated log files to the Amazon S3 bucket that you specify in ApplicationLogOutputUri
at the end of a stream session. To retrieve stored log files, call GetStreamSession and get the LogFileLocationUri
.
Sourcepub fn set_application_log_paths(self, input: Option<Vec<String>>) -> Self
pub fn set_application_log_paths(self, input: Option<Vec<String>>) -> Self
Locations of log files that your content generates during a stream session. Enter path values that are relative to the ApplicationSourceUri
location. You can specify up to 10 log paths. Amazon GameLift Streams uploads designated log files to the Amazon S3 bucket that you specify in ApplicationLogOutputUri
at the end of a stream session. To retrieve stored log files, call GetStreamSession and get the LogFileLocationUri
.
Sourcepub fn get_application_log_paths(&self) -> &Option<Vec<String>>
pub fn get_application_log_paths(&self) -> &Option<Vec<String>>
Locations of log files that your content generates during a stream session. Enter path values that are relative to the ApplicationSourceUri
location. You can specify up to 10 log paths. Amazon GameLift Streams uploads designated log files to the Amazon S3 bucket that you specify in ApplicationLogOutputUri
at the end of a stream session. To retrieve stored log files, call GetStreamSession and get the LogFileLocationUri
.
Sourcepub fn application_log_output_uri(self, input: impl Into<String>) -> Self
pub fn application_log_output_uri(self, input: impl Into<String>) -> Self
An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more ApplicationLogPaths
.
The log bucket must have permissions that give Amazon GameLift Streams access to write the log files. For more information, see Application log bucket permission policy in the Amazon GameLift Streams Developer Guide.
Sourcepub fn set_application_log_output_uri(self, input: Option<String>) -> Self
pub fn set_application_log_output_uri(self, input: Option<String>) -> Self
An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more ApplicationLogPaths
.
The log bucket must have permissions that give Amazon GameLift Streams access to write the log files. For more information, see Application log bucket permission policy in the Amazon GameLift Streams Developer Guide.
Sourcepub fn get_application_log_output_uri(&self) -> &Option<String>
pub fn get_application_log_output_uri(&self) -> &Option<String>
An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more ApplicationLogPaths
.
The log bucket must have permissions that give Amazon GameLift Streams access to write the log files. For more information, see Application log bucket permission policy in the Amazon GameLift Streams Developer Guide.
Adds a key-value pair to Tags
.
To override the contents of this collection use set_tags
.
A list of labels to assign to the new application resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access management and cost allocation. See Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. You can use TagResource to add tags, UntagResource to remove tags, and ListTagsForResource to view tags on existing resources.
A list of labels to assign to the new application resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access management and cost allocation. See Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. You can use TagResource to add tags, UntagResource to remove tags, and ListTagsForResource to view tags on existing resources.
A list of labels to assign to the new application resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access management and cost allocation. See Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. You can use TagResource to add tags, UntagResource to remove tags, and ListTagsForResource to view tags on existing resources.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field.
Trait Implementations§
Source§impl Clone for CreateApplicationFluentBuilder
impl Clone for CreateApplicationFluentBuilder
Source§fn clone(&self) -> CreateApplicationFluentBuilder
fn clone(&self) -> CreateApplicationFluentBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CreateApplicationFluentBuilder
impl !RefUnwindSafe for CreateApplicationFluentBuilder
impl Send for CreateApplicationFluentBuilder
impl Sync for CreateApplicationFluentBuilder
impl Unpin for CreateApplicationFluentBuilder
impl !UnwindSafe for CreateApplicationFluentBuilder
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);