Skip to main content

aws_sdk_securityagent/client/
create_pentest.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 [`CreatePentest`](crate::operation::create_pentest::builders::CreatePentestFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`title(impl Into<String>)`](crate::operation::create_pentest::builders::CreatePentestFluentBuilder::title) / [`set_title(Option<String>)`](crate::operation::create_pentest::builders::CreatePentestFluentBuilder::set_title):<br>required: **true**<br>Title of the pentest<br>
7    ///   - [`agent_space_id(impl Into<String>)`](crate::operation::create_pentest::builders::CreatePentestFluentBuilder::agent_space_id) / [`set_agent_space_id(Option<String>)`](crate::operation::create_pentest::builders::CreatePentestFluentBuilder::set_agent_space_id):<br>required: **true**<br>ID of the agent space where the pentest should be created<br>
8    ///   - [`assets(Assets)`](crate::operation::create_pentest::builders::CreatePentestFluentBuilder::assets) / [`set_assets(Option<Assets>)`](crate::operation::create_pentest::builders::CreatePentestFluentBuilder::set_assets):<br>required: **false**<br>Assets to be tested during the pentest<br>
9    ///   - [`exclude_risk_types(RiskType)`](crate::operation::create_pentest::builders::CreatePentestFluentBuilder::exclude_risk_types) / [`set_exclude_risk_types(Option<Vec::<RiskType>>)`](crate::operation::create_pentest::builders::CreatePentestFluentBuilder::set_exclude_risk_types):<br>required: **false**<br>A list of risk types excluded from the pentest execution<br>
10    ///   - [`service_role(impl Into<String>)`](crate::operation::create_pentest::builders::CreatePentestFluentBuilder::service_role) / [`set_service_role(Option<String>)`](crate::operation::create_pentest::builders::CreatePentestFluentBuilder::set_service_role):<br>required: **false**<br>Service role ARN for accessing customer resources<br>
11    ///   - [`log_config(CloudWatchLog)`](crate::operation::create_pentest::builders::CreatePentestFluentBuilder::log_config) / [`set_log_config(Option<CloudWatchLog>)`](crate::operation::create_pentest::builders::CreatePentestFluentBuilder::set_log_config):<br>required: **false**<br>CloudWatch log group and stream prefix where pentest execution logs are stored<br>
12    ///   - [`vpc_config(VpcConfig)`](crate::operation::create_pentest::builders::CreatePentestFluentBuilder::vpc_config) / [`set_vpc_config(Option<VpcConfig>)`](crate::operation::create_pentest::builders::CreatePentestFluentBuilder::set_vpc_config):<br>required: **false**<br>VPC configuration that the Security Agent accesses<br>
13    ///   - [`network_traffic_config(NetworkTrafficConfig)`](crate::operation::create_pentest::builders::CreatePentestFluentBuilder::network_traffic_config) / [`set_network_traffic_config(Option<NetworkTrafficConfig>)`](crate::operation::create_pentest::builders::CreatePentestFluentBuilder::set_network_traffic_config):<br>required: **false**<br>Configuration for network traffic filtering<br>
14    ///   - [`code_remediation_strategy(CodeRemediationStrategy)`](crate::operation::create_pentest::builders::CreatePentestFluentBuilder::code_remediation_strategy) / [`set_code_remediation_strategy(Option<CodeRemediationStrategy>)`](crate::operation::create_pentest::builders::CreatePentestFluentBuilder::set_code_remediation_strategy):<br>required: **false**<br>Strategy for code remediation on findings<br>
15    /// - On success, responds with [`CreatePentestOutput`](crate::operation::create_pentest::CreatePentestOutput) with field(s):
16    ///   - [`pentest_id(Option<String>)`](crate::operation::create_pentest::CreatePentestOutput::pentest_id): Unique identifier of the created pentest
17    ///   - [`title(Option<String>)`](crate::operation::create_pentest::CreatePentestOutput::title): Title of the created pentest
18    ///   - [`created_at(Option<DateTime>)`](crate::operation::create_pentest::CreatePentestOutput::created_at): Timestamp when the pentest was created
19    ///   - [`updated_at(Option<DateTime>)`](crate::operation::create_pentest::CreatePentestOutput::updated_at): Timestamp when the pentest was last updated
20    ///   - [`assets(Option<Assets>)`](crate::operation::create_pentest::CreatePentestOutput::assets): Assets to be tested in the created pentest
21    ///   - [`exclude_risk_types(Option<Vec::<RiskType>>)`](crate::operation::create_pentest::CreatePentestOutput::exclude_risk_types): A list of risk types excluded from the pentest execution
22    ///   - [`service_role(Option<String>)`](crate::operation::create_pentest::CreatePentestOutput::service_role): Service role ARN for accessing customer resources
23    ///   - [`log_config(Option<CloudWatchLog>)`](crate::operation::create_pentest::CreatePentestOutput::log_config): CloudWatch log group and stream prefix where pentest execution logs are stored
24    ///   - [`agent_space_id(Option<String>)`](crate::operation::create_pentest::CreatePentestOutput::agent_space_id): ID of the agent space where the pentest was created
25    /// - On failure, responds with [`SdkError<CreatePentestError>`](crate::operation::create_pentest::CreatePentestError)
26    pub fn create_pentest(&self) -> crate::operation::create_pentest::builders::CreatePentestFluentBuilder {
27        crate::operation::create_pentest::builders::CreatePentestFluentBuilder::new(self.handle.clone())
28    }
29}