Skip to main content

aws_sdk_mgn/client/
get_network_migration_definition.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 [`GetNetworkMigrationDefinition`](crate::operation::get_network_migration_definition::builders::GetNetworkMigrationDefinitionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`network_migration_definition_id(impl Into<String>)`](crate::operation::get_network_migration_definition::builders::GetNetworkMigrationDefinitionFluentBuilder::network_migration_definition_id) / [`set_network_migration_definition_id(Option<String>)`](crate::operation::get_network_migration_definition::builders::GetNetworkMigrationDefinitionFluentBuilder::set_network_migration_definition_id):<br>required: **true**<br><p>The unique identifier of the network migration definition to retrieve.</p><br>
7    /// - On success, responds with [`GetNetworkMigrationDefinitionOutput`](crate::operation::get_network_migration_definition::GetNetworkMigrationDefinitionOutput) with field(s):
8    ///   - [`arn(Option<String>)`](crate::operation::get_network_migration_definition::GetNetworkMigrationDefinitionOutput::arn): <p>The Amazon Resource Name (ARN) of the network migration definition.</p>
9    ///   - [`network_migration_definition_id(Option<String>)`](crate::operation::get_network_migration_definition::GetNetworkMigrationDefinitionOutput::network_migration_definition_id): <p>The unique identifier of the network migration definition.</p>
10    ///   - [`name(Option<String>)`](crate::operation::get_network_migration_definition::GetNetworkMigrationDefinitionOutput::name): <p>The name of the network migration definition.</p>
11    ///   - [`description(Option<String>)`](crate::operation::get_network_migration_definition::GetNetworkMigrationDefinitionOutput::description): <p>A description of the network migration definition.</p>
12    ///   - [`source_configurations(Option<Vec::<SourceConfiguration>>)`](crate::operation::get_network_migration_definition::GetNetworkMigrationDefinitionOutput::source_configurations): <p>A list of source configurations for the network migration.</p>
13    ///   - [`target_s3_configuration(Option<TargetS3Configuration>)`](crate::operation::get_network_migration_definition::GetNetworkMigrationDefinitionOutput::target_s3_configuration): <p>The S3 configuration for storing the target network artifacts.</p>
14    ///   - [`target_network(Option<TargetNetwork>)`](crate::operation::get_network_migration_definition::GetNetworkMigrationDefinitionOutput::target_network): <p>The target network configuration including topology and CIDR ranges.</p>
15    ///   - [`target_deployment(Option<TargetDeployment>)`](crate::operation::get_network_migration_definition::GetNetworkMigrationDefinitionOutput::target_deployment): <p>The target deployment configuration for the migrated network.</p>
16    ///   - [`vpc_provisioning_strategy(Option<VpcProvisioningStrategy>)`](crate::operation::get_network_migration_definition::GetNetworkMigrationDefinitionOutput::vpc_provisioning_strategy): <p>Indicates whether the migration creates new target VPCs or uses existing ones. <code>CREATE_NEW</code> provisions new target VPCs; <code>USE_EXISTING</code> migrates into existing VPCs in the target account.</p>
17    ///   - [`cidr_mappings(Option<Vec::<CidrMapping>>)`](crate::operation::get_network_migration_definition::GetNetworkMigrationDefinitionOutput::cidr_mappings): <p>A list of CIDR mappings that map original source CIDR ranges to updated target CIDR ranges. CIDR mappings apply only when <code>vpcProvisioningStrategy</code> is set to <code>USE_EXISTING</code>.</p>
18    ///   - [`created_at(Option<DateTime>)`](crate::operation::get_network_migration_definition::GetNetworkMigrationDefinitionOutput::created_at): <p>The timestamp when the network migration definition was created.</p>
19    ///   - [`updated_at(Option<DateTime>)`](crate::operation::get_network_migration_definition::GetNetworkMigrationDefinitionOutput::updated_at): <p>The timestamp when the network migration definition was last updated.</p>
20    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_network_migration_definition::GetNetworkMigrationDefinitionOutput::tags): <p>Tags assigned to the network migration definition.</p>
21    ///   - [`scope_tags(Option<HashMap::<String, String>>)`](crate::operation::get_network_migration_definition::GetNetworkMigrationDefinitionOutput::scope_tags): <p>Scope tags for the network migration definition.</p>
22    /// - On failure, responds with [`SdkError<GetNetworkMigrationDefinitionError>`](crate::operation::get_network_migration_definition::GetNetworkMigrationDefinitionError)
23    pub fn get_network_migration_definition(
24        &self,
25    ) -> crate::operation::get_network_migration_definition::builders::GetNetworkMigrationDefinitionFluentBuilder {
26        crate::operation::get_network_migration_definition::builders::GetNetworkMigrationDefinitionFluentBuilder::new(self.handle.clone())
27    }
28}