aws_sdk_codestar/client/
delete_project.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 [`DeleteProject`](crate::operation::delete_project::builders::DeleteProjectFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`id(impl Into<String>)`](crate::operation::delete_project::builders::DeleteProjectFluentBuilder::id) / [`set_id(Option<String>)`](crate::operation::delete_project::builders::DeleteProjectFluentBuilder::set_id):<br>required: **true**<br><p>The ID of the project to be deleted in AWS CodeStar.</p><br>
7    ///   - [`client_request_token(impl Into<String>)`](crate::operation::delete_project::builders::DeleteProjectFluentBuilder::client_request_token) / [`set_client_request_token(Option<String>)`](crate::operation::delete_project::builders::DeleteProjectFluentBuilder::set_client_request_token):<br>required: **false**<br><p>A user- or system-generated token that identifies the entity that requested project deletion. This token can be used to repeat the request.</p><br>
8    ///   - [`delete_stack(bool)`](crate::operation::delete_project::builders::DeleteProjectFluentBuilder::delete_stack) / [`set_delete_stack(Option<bool>)`](crate::operation::delete_project::builders::DeleteProjectFluentBuilder::set_delete_stack):<br>required: **false**<br><p>Whether to send a delete request for the primary stack in AWS CloudFormation originally used to generate the project and its resources. This option will delete all AWS resources for the project (except for any buckets in Amazon S3) as well as deleting the project itself. Recommended for most use cases.</p><br>
9    /// - On success, responds with [`DeleteProjectOutput`](crate::operation::delete_project::DeleteProjectOutput) with field(s):
10    ///   - [`stack_id(Option<String>)`](crate::operation::delete_project::DeleteProjectOutput::stack_id): <p>The ID of the primary stack in AWS CloudFormation that will be deleted as part of deleting the project and its resources.</p>
11    ///   - [`project_arn(Option<String>)`](crate::operation::delete_project::DeleteProjectOutput::project_arn): <p>The Amazon Resource Name (ARN) of the deleted project.</p>
12    /// - On failure, responds with [`SdkError<DeleteProjectError>`](crate::operation::delete_project::DeleteProjectError)
13    pub fn delete_project(&self) -> crate::operation::delete_project::builders::DeleteProjectFluentBuilder {
14        crate::operation::delete_project::builders::DeleteProjectFluentBuilder::new(self.handle.clone())
15    }
16}