aws_sdk_gamelift/client/create_build.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`CreateBuild`](crate::operation::create_build::builders::CreateBuildFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`name(impl Into<String>)`](crate::operation::create_build::builders::CreateBuildFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_build::builders::CreateBuildFluentBuilder::set_name):<br>required: **false**<br><p>A descriptive label that is associated with a build. Build names do not need to be unique. You can change this value later.</p><br>
7 /// - [`version(impl Into<String>)`](crate::operation::create_build::builders::CreateBuildFluentBuilder::version) / [`set_version(Option<String>)`](crate::operation::create_build::builders::CreateBuildFluentBuilder::set_version):<br>required: **false**<br><p>Version information that is associated with a build or script. Version strings do not need to be unique. You can change this value later.</p><br>
8 /// - [`storage_location(S3Location)`](crate::operation::create_build::builders::CreateBuildFluentBuilder::storage_location) / [`set_storage_location(Option<S3Location>)`](crate::operation::create_build::builders::CreateBuildFluentBuilder::set_storage_location):<br>required: **false**<br><p>Information indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift Servers to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region.</p> <p>If a <code>StorageLocation</code> is specified, the size of your file can be found in your Amazon S3 bucket. Amazon GameLift Servers will report a <code>SizeOnDisk</code> of 0.</p><br>
9 /// - [`operating_system(OperatingSystem)`](crate::operation::create_build::builders::CreateBuildFluentBuilder::operating_system) / [`set_operating_system(Option<OperatingSystem>)`](crate::operation::create_build::builders::CreateBuildFluentBuilder::set_operating_system):<br>required: **false**<br><p>The operating system that your game server binaries run on. This value determines the type of fleet resources that you use for this build. If your game build contains multiple executables, they all must run on the same operating system. You must specify a valid operating system in this request. There is no default value. You can't change a build's operating system later.</p><note> <p>Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the <a href="http://aws.amazon.com/amazon-linux-2/faqs/">Amazon Linux 2 FAQs</a>. For game servers that are hosted on AL2 and use server SDK version 4.x for Amazon GameLift Servers, first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html"> Migrate to server SDK version 5.</a></p> </note><br>
10 /// - [`tags(Tag)`](crate::operation::create_build::builders::CreateBuildFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_build::builders::CreateBuildFluentBuilder::set_tags):<br>required: **false**<br><p>A list of labels to assign to the new build resource. Tags are developer defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>. Once the resource is created, you can use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_TagResource.html">TagResource</a>, <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UntagResource.html">UntagResource</a>, and <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListTagsForResource.html">ListTagsForResource</a> to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.</p><br>
11 /// - [`server_sdk_version(impl Into<String>)`](crate::operation::create_build::builders::CreateBuildFluentBuilder::server_sdk_version) / [`set_server_sdk_version(Option<String>)`](crate::operation::create_build::builders::CreateBuildFluentBuilder::set_server_sdk_version):<br>required: **false**<br><p>A server SDK version you used when integrating your game server build with Amazon GameLift Servers. For more information see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-custom-intro.html">Integrate games with custom game servers</a>. By default Amazon GameLift Servers sets this value to <code>4.0.2</code>.</p><br>
12 /// - On success, responds with [`CreateBuildOutput`](crate::operation::create_build::CreateBuildOutput) with field(s):
13 /// - [`build_value(Option<Build>)`](crate::operation::create_build::CreateBuildOutput::build_value): <p>The newly created build resource, including a unique build IDs and status.</p>
14 /// - [`upload_credentials(Option<AwsCredentials>)`](crate::operation::create_build::CreateBuildOutput::upload_credentials): <p>This element is returned only when the operation is called without a storage location. It contains credentials to use when you are uploading a build file to an Amazon S3 bucket that is owned by Amazon GameLift Servers. Credentials have a limited life span. To refresh these credentials, call <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_RequestUploadCredentials.html">RequestUploadCredentials</a>.</p>
15 /// - [`storage_location(Option<S3Location>)`](crate::operation::create_build::CreateBuildOutput::storage_location): <p>Amazon S3 location for your game build file, including bucket name and key.</p>
16 /// - On failure, responds with [`SdkError<CreateBuildError>`](crate::operation::create_build::CreateBuildError)
17 pub fn create_build(&self) -> crate::operation::create_build::builders::CreateBuildFluentBuilder {
18 crate::operation::create_build::builders::CreateBuildFluentBuilder::new(self.handle.clone())
19 }
20}