aws_sdk_imagebuilder/client/
create_image_pipeline.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 [`CreateImagePipeline`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`name(impl Into<String>)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::set_name):<br>required: **true**<br><p>The name of the image pipeline.</p><br>
7    ///   - [`description(impl Into<String>)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::set_description):<br>required: **false**<br><p>The description of the image pipeline.</p><br>
8    ///   - [`image_recipe_arn(impl Into<String>)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::image_recipe_arn) / [`set_image_recipe_arn(Option<String>)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::set_image_recipe_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the image recipe that configures images created by this image pipeline.</p><br>
9    ///   - [`container_recipe_arn(impl Into<String>)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::container_recipe_arn) / [`set_container_recipe_arn(Option<String>)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::set_container_recipe_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline.</p><br>
10    ///   - [`infrastructure_configuration_arn(impl Into<String>)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::infrastructure_configuration_arn) / [`set_infrastructure_configuration_arn(Option<String>)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::set_infrastructure_configuration_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the infrastructure configuration that builds images created by this image pipeline.</p><br>
11    ///   - [`distribution_configuration_arn(impl Into<String>)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::distribution_configuration_arn) / [`set_distribution_configuration_arn(Option<String>)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::set_distribution_configuration_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the distribution configuration that configures and distributes images created by this image pipeline.</p><br>
12    ///   - [`image_tests_configuration(ImageTestsConfiguration)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::image_tests_configuration) / [`set_image_tests_configuration(Option<ImageTestsConfiguration>)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::set_image_tests_configuration):<br>required: **false**<br><p>The image test configuration of the image pipeline.</p><br>
13    ///   - [`enhanced_image_metadata_enabled(bool)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::enhanced_image_metadata_enabled) / [`set_enhanced_image_metadata_enabled(Option<bool>)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::set_enhanced_image_metadata_enabled):<br>required: **false**<br><p>Specifies whether to collect additional information about the image being created, including the operating system (OS) version and package list. Defaults to <code>true</code>.</p><br>
14    ///   - [`schedule(Schedule)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::schedule) / [`set_schedule(Option<Schedule>)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::set_schedule):<br>required: **false**<br><p>The schedule of the image pipeline.</p><br>
15    ///   - [`status(PipelineStatus)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::status) / [`set_status(Option<PipelineStatus>)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::set_status):<br>required: **false**<br><p>The status of the image pipeline.</p><br>
16    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::set_tags):<br>required: **false**<br><p>The tags of the image pipeline.</p><br>
17    ///   - [`image_tags(impl Into<String>, impl Into<String>)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::image_tags) / [`set_image_tags(Option<HashMap::<String, String>>)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::set_image_tags):<br>required: **false**<br><p>The tags to be applied to the images produced by this pipeline.</p><br>
18    ///   - [`client_token(impl Into<String>)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::set_client_token):<br>required: **true**<br><p>A unique, case-sensitive identifier you provide to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon EC2 API Reference</i>.</p><br>
19    ///   - [`image_scanning_configuration(ImageScanningConfiguration)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::image_scanning_configuration) / [`set_image_scanning_configuration(Option<ImageScanningConfiguration>)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::set_image_scanning_configuration):<br>required: **false**<br><p>Contains settings for vulnerability scans.</p><br>
20    ///   - [`workflows(WorkflowConfiguration)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::workflows) / [`set_workflows(Option<Vec::<WorkflowConfiguration>>)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::set_workflows):<br>required: **false**<br><p>Contains an array of workflow configuration objects.</p><br>
21    ///   - [`execution_role(impl Into<String>)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::execution_role) / [`set_execution_role(Option<String>)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::set_execution_role):<br>required: **false**<br><p>The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.</p><br>
22    ///   - [`logging_configuration(PipelineLoggingConfiguration)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::logging_configuration) / [`set_logging_configuration(Option<PipelineLoggingConfiguration>)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::set_logging_configuration):<br>required: **false**<br><p>Specifies the logging configuration for the image pipeline. Use this to define custom CloudWatch Logs log groups for your pipeline execution logs and image build logs. The service manages log groups with names starting with <code>/aws/imagebuilder/</code> using the service-linked role. For custom log group names outside of this prefix, you must also provide an <code>executionRole</code>.</p><br>
23    ///   - [`dry_run(bool)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::set_dry_run):<br>required: **false**<br><p>Validates the required permissions and request parameters without making the request. If validation succeeds, the operation returns a <code>DryRunOperationException</code> error response.</p><br>
24    /// - On success, responds with [`CreateImagePipelineOutput`](crate::operation::create_image_pipeline::CreateImagePipelineOutput) with field(s):
25    ///   - [`request_id(Option<String>)`](crate::operation::create_image_pipeline::CreateImagePipelineOutput::request_id): <p>The request ID that uniquely identifies this request.</p>
26    ///   - [`client_token(Option<String>)`](crate::operation::create_image_pipeline::CreateImagePipelineOutput::client_token): <p>The client token that uniquely identifies the request.</p>
27    ///   - [`image_pipeline_arn(Option<String>)`](crate::operation::create_image_pipeline::CreateImagePipelineOutput::image_pipeline_arn): <p>The Amazon Resource Name (ARN) of the image pipeline that was created by this request.</p>
28    /// - On failure, responds with [`SdkError<CreateImagePipelineError>`](crate::operation::create_image_pipeline::CreateImagePipelineError)
29    pub fn create_image_pipeline(&self) -> crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder {
30        crate::operation::create_image_pipeline::builders::CreateImagePipelineFluentBuilder::new(self.handle.clone())
31    }
32}
aws_sdk_imagebuilder/client/create_image_pipeline.rs

aws_sdk_imagebuilder/client/
create_image_pipeline.rs
