aws_sdk_databasemigration/client/
create_replication_instance.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateReplicationInstance`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`replication_instance_identifier(impl Into<String>)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::replication_instance_identifier) / [`set_replication_instance_identifier(Option<String>)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::set_replication_instance_identifier):<br>required: **true**<br><p>The replication instance identifier. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul>  <li>   <p>Must contain 1-63 alphanumeric characters or hyphens.</p></li>  <li>   <p>First character must be a letter.</p></li>  <li>   <p>Can't end with a hyphen or contain two consecutive hyphens.</p></li> </ul> <p>Example: <code>myrepinstance</code></p><br>
    ///   - [`allocated_storage(i32)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::allocated_storage) / [`set_allocated_storage(Option<i32>)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::set_allocated_storage):<br>required: **false**<br><p>The amount of storage (in gigabytes) to be initially allocated for the replication instance.</p><br>
    ///   - [`replication_instance_class(impl Into<String>)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::replication_instance_class) / [`set_replication_instance_class(Option<String>)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::set_replication_instance_class):<br>required: **true**<br><p>The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to <code>"dms.c4.large"</code>.</p> <p>For more information on the settings and capacities for the available replication instance classes, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.Types.html "> Choosing the right DMS replication instance</a>; and, <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_BestPractices.SizingReplicationInstance.html">Selecting the best size for a replication instance</a>.</p><br>
    ///   - [`vpc_security_group_ids(impl Into<String>)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::vpc_security_group_ids) / [`set_vpc_security_group_ids(Option<Vec::<String>>)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::set_vpc_security_group_ids):<br>required: **false**<br><p>Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance.</p><br>
    ///   - [`availability_zone(impl Into<String>)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::availability_zone) / [`set_availability_zone(Option<String>)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::set_availability_zone):<br>required: **false**<br><p>The Availability Zone where the replication instance will be created. The default value is a random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region, for example: <code>us-east-1d</code>.</p><br>
    ///   - [`replication_subnet_group_identifier(impl Into<String>)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::replication_subnet_group_identifier) / [`set_replication_subnet_group_identifier(Option<String>)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::set_replication_subnet_group_identifier):<br>required: **false**<br><p>A subnet group to associate with the replication instance.</p><br>
    ///   - [`preferred_maintenance_window(impl Into<String>)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::preferred_maintenance_window) / [`set_preferred_maintenance_window(Option<String>)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::set_preferred_maintenance_window):<br>required: **false**<br><p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p> <p>Format: <code>ddd:hh24:mi-ddd:hh24:mi</code></p> <p>Default: A 30-minute window selected at random from an 8-hour block of time per Amazon Web Services Region, occurring on a random day of the week.</p> <p>Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun</p> <p>Constraints: Minimum 30-minute window.</p><br>
    ///   - [`multi_az(bool)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::multi_az) / [`set_multi_az(Option<bool>)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::set_multi_az):<br>required: **false**<br><p>Specifies whether the replication instance is a Multi-AZ deployment. You can't set the <code>AvailabilityZone</code> parameter if the Multi-AZ parameter is set to <code>true</code>.</p><br>
    ///   - [`engine_version(impl Into<String>)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::engine_version) / [`set_engine_version(Option<String>)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::set_engine_version):<br>required: **false**<br><p>The engine version number of the replication instance.</p> <p>If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.</p><br>
    ///   - [`auto_minor_version_upgrade(bool)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::auto_minor_version_upgrade) / [`set_auto_minor_version_upgrade(Option<bool>)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::set_auto_minor_version_upgrade):<br>required: **false**<br><p>A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window. This parameter defaults to <code>true</code>.</p> <p>Default: <code>true</code></p><br>
    ///   - [`tags(Tag)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::set_tags):<br>required: **false**<br><p>One or more tags to be assigned to the replication instance.</p><br>
    ///   - [`kms_key_id(impl Into<String>)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::kms_key_id) / [`set_kms_key_id(Option<String>)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::set_kms_key_id):<br>required: **false**<br><p>An KMS key identifier that is used to encrypt the data on the replication instance.</p> <p>If you don't specify a value for the <code>KmsKeyId</code> parameter, then DMS uses your default encryption key.</p> <p>KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.</p><br>
    ///   - [`publicly_accessible(bool)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::publicly_accessible) / [`set_publicly_accessible(Option<bool>)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::set_publicly_accessible):<br>required: **false**<br><p>Specifies the accessibility options for the replication instance. A value of <code>true</code> represents an instance with a public IP address. A value of <code>false</code> represents an instance with a private IP address. The default value is <code>true</code>.</p><br>
    ///   - [`dns_name_servers(impl Into<String>)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::dns_name_servers) / [`set_dns_name_servers(Option<String>)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::set_dns_name_servers):<br>required: **false**<br><p>A list of custom DNS name servers supported for the replication instance to access your on-premise source or target database. This list overrides the default name servers supported by the replication instance. You can specify a comma-separated list of internet addresses for up to four on-premise DNS name servers. For example: <code>"1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4"</code></p><br>
    ///   - [`resource_identifier(impl Into<String>)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::resource_identifier) / [`set_resource_identifier(Option<String>)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::set_resource_identifier):<br>required: **false**<br><p>A friendly name for the resource identifier at the end of the <code>EndpointArn</code> response parameter that is returned in the created <code>Endpoint</code> object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as <code>Example-App-ARN1</code>. For example, this value might result in the <code>EndpointArn</code> value <code>arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1</code>. If you don't specify a <code>ResourceIdentifier</code> value, DMS generates a default identifier value for the end of <code>EndpointArn</code>.</p><br>
    ///   - [`network_type(impl Into<String>)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::network_type) / [`set_network_type(Option<String>)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::set_network_type):<br>required: **false**<br><p>The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.</p><br>
    ///   - [`kerberos_authentication_settings(KerberosAuthenticationSettings)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::kerberos_authentication_settings) / [`set_kerberos_authentication_settings(Option<KerberosAuthenticationSettings>)`](crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::set_kerberos_authentication_settings):<br>required: **false**<br><p>Specifies the ID of the secret that stores the key cache file required for kerberos authentication, when creating a replication instance.</p><br>
    /// - On success, responds with [`CreateReplicationInstanceOutput`](crate::operation::create_replication_instance::CreateReplicationInstanceOutput) with field(s):
    ///   - [`replication_instance(Option<ReplicationInstance>)`](crate::operation::create_replication_instance::CreateReplicationInstanceOutput::replication_instance): <p>The replication instance that was created.</p>
    /// - On failure, responds with [`SdkError<CreateReplicationInstanceError>`](crate::operation::create_replication_instance::CreateReplicationInstanceError)
    pub fn create_replication_instance(&self) -> crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder {
        crate::operation::create_replication_instance::builders::CreateReplicationInstanceFluentBuilder::new(self.handle.clone())
    }
}