create_replication_instance async ¶

async def create_replication_instance(
    self,
    replication_instance_identifier: "capo_database_migration_service.types.string.String",
    replication_instance_class: "capo_database_migration_service.types.replication_instance_class.ReplicationInstanceClass",
    *,
    config_overrides: Optional[AsyncDatabaseMigrationServiceClientConfig] = None,
    allocated_storage: Optional[
        "capo_database_migration_service.types.integer_optional.IntegerOptional"
    ] = None,
    vpc_security_group_ids: Optional[
        "capo_database_migration_service.types.vpc_security_group_id_list.VpcSecurityGroupIdList"
    ] = None,
    availability_zone: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    replication_subnet_group_identifier: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    preferred_maintenance_window: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    multi_az: Optional[
        "capo_database_migration_service.types.boolean_optional.BooleanOptional"
    ] = None,
    engine_version: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    auto_minor_version_upgrade: Optional[
        "capo_database_migration_service.types.boolean_optional.BooleanOptional"
    ] = None,
    tags: Optional["capo_database_migration_service.types.tag_list.TagList"] = None,
    kms_key_id: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    publicly_accessible: Optional[
        "capo_database_migration_service.types.boolean_optional.BooleanOptional"
    ] = None,
    dns_name_servers: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    resource_identifier: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    network_type: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    kerberos_authentication_settings: Optional[
        "capo_database_migration_service.types.kerberos_authentication_settings.KerberosAuthenticationSettings"
    ] = None,
) -> "capo_database_migration_service.types.create_replication_instance_response.CreateReplicationInstanceResponse":
    """<p>Creates the replication instance using the specified parameters.</p> <p>DMS requires that your account have certain roles with appropriate permissions before you can create a replication instance. For information on the required roles, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#CHAP_Security.APIRole">Creating the IAM Roles to Use With the CLI and DMS API</a>. For information on the required permissions, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#CHAP_Security.IAMPermissions">IAM Permissions Needed to Use DMS</a>.</p> <note> <p>If you don't specify a version when creating a replication instance, DMS will create the instance using the default engine version. For information about the default engine version, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReleaseNotes.html">Release Notes</a>.</p> </note>

    Args:
        replication_instance_identifier: <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>
        allocated_storage: <p>The amount of storage (in gigabytes) to be initially allocated for the replication instance.</p>
        replication_instance_class: <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>
        vpc_security_group_ids: <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>
        availability_zone: <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>
        replication_subnet_group_identifier: <p>A subnet group to associate with the replication instance.</p>
        preferred_maintenance_window: <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>
        multi_az: <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>
        engine_version: <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>
        auto_minor_version_upgrade: <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>
        tags: <p>One or more tags to be assigned to the replication instance.</p>
        kms_key_id: <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>
        publicly_accessible: <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>
        dns_name_servers: <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>
        resource_identifier: <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>
        network_type: <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>
        kerberos_authentication_settings: <p>Specifies the settings required for kerberos authentication when creating the replication instance.</p>

    Raises:
        capo_database_migration_service.errors.access_denied_fault.AccessDeniedFault: <p>DMS was denied access to the endpoint. Check that the role is correctly configured.</p>
        capo_database_migration_service.errors.insufficient_resource_capacity_fault.InsufficientResourceCapacityFault: <p>There are not enough resources allocated to the database migration.</p>
        capo_database_migration_service.errors.invalid_resource_state_fault.InvalidResourceStateFault: <p>The resource is in a state that prevents it from being used for database migration.</p>
        capo_database_migration_service.errors.invalid_subnet.InvalidSubnet: <p>The subnet provided isn't valid.</p>
        capo_database_migration_service.errors.kms_key_not_accessible_fault.KMSKeyNotAccessibleFault: <p>DMS cannot access the KMS key.</p>
        capo_database_migration_service.errors.replication_subnet_group_does_not_cover_enough_a_zs.ReplicationSubnetGroupDoesNotCoverEnoughAZs: <p>The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet group and add more AZs.</p>
        capo_database_migration_service.errors.resource_already_exists_fault.ResourceAlreadyExistsFault: <p>The resource you are attempting to create already exists.</p>
        capo_database_migration_service.errors.resource_not_found_fault.ResourceNotFoundFault: <p>The resource could not be found.</p>
        capo_database_migration_service.errors.resource_quota_exceeded_fault.ResourceQuotaExceededFault: <p>The quota for this resource quota has been exceeded.</p>
        capo_database_migration_service.errors.storage_quota_exceeded_fault.StorageQuotaExceededFault: <p>The storage quota has been exceeded.</p>
        capo_database_migration_service.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Create replication instance
        Creates the replication instance using the specified parameters.

        >>> await client.create_replication_instance(replication_instance_identifier='', allocated_storage=123, replication_instance_class='', vpc_security_group_ids=[], availability_zone='', replication_subnet_group_identifier='', preferred_maintenance_window='', multi_az=True, engine_version='', auto_minor_version_upgrade=True, tags=[{'Key': 'string', 'Value': 'string'}], kms_key_id='', publicly_accessible=True)
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_database_migration_service.types.create_replication_instance_message.CreateReplicationInstanceMessage]",
    ) -> AsyncOperationResponse[
        "capo_database_migration_service.types.create_replication_instance_response.CreateReplicationInstanceResponse"
    ]:
        import capo_database_migration_service._operations.amazon_dm_sv20160101.create_replication_instance

        (
            output,
            http_response,
        ) = await capo_database_migration_service._operations.amazon_dm_sv20160101.create_replication_instance.async_create_replication_instance(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateReplicationInstance")
    )
    input_: capo_database_migration_service.types.create_replication_instance_message.CreateReplicationInstanceMessage = {
        "replication_instance_identifier": replication_instance_identifier,
        "replication_instance_class": replication_instance_class,
    }
    if allocated_storage is not None:
        input_["allocated_storage"] = allocated_storage
    if vpc_security_group_ids is not None:
        input_["vpc_security_group_ids"] = vpc_security_group_ids
    if availability_zone is not None:
        input_["availability_zone"] = availability_zone
    if replication_subnet_group_identifier is not None:
        input_["replication_subnet_group_identifier"] = (
            replication_subnet_group_identifier
        )
    if preferred_maintenance_window is not None:
        input_["preferred_maintenance_window"] = preferred_maintenance_window
    if multi_az is not None:
        input_["multi_az"] = multi_az
    if engine_version is not None:
        input_["engine_version"] = engine_version
    if auto_minor_version_upgrade is not None:
        input_["auto_minor_version_upgrade"] = auto_minor_version_upgrade
    if tags is not None:
        input_["tags"] = tags
    if kms_key_id is not None:
        input_["kms_key_id"] = kms_key_id
    if publicly_accessible is not None:
        input_["publicly_accessible"] = publicly_accessible
    if dns_name_servers is not None:
        input_["dns_name_servers"] = dns_name_servers
    if resource_identifier is not None:
        input_["resource_identifier"] = resource_identifier
    if network_type is not None:
        input_["network_type"] = network_type
    if kerberos_authentication_settings is not None:
        input_["kerberos_authentication_settings"] = (
            kerberos_authentication_settings
        )

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output