RDSClient
Auto-generated documentation for RDS type annotations stubs module mypy-boto3-rds.
RDSClient
Type annotations and code completion for boto3.client("rds")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_rds.client import RDSClient
def get_rds_client() -> RDSClient:
return Session().client("rds")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("rds").exceptions
structure.
client = boto3.client("rds")
try:
do_something(client)
except (
client.AuthorizationAlreadyExistsFault,
client.AuthorizationNotFoundFault,
client.AuthorizationQuotaExceededFault,
client.BackupPolicyNotFoundFault,
client.BlueGreenDeploymentAlreadyExistsFault,
client.BlueGreenDeploymentNotFoundFault,
client.CertificateNotFoundFault,
client.ClientError,
client.CustomAvailabilityZoneNotFoundFault,
client.CustomDBEngineVersionAlreadyExistsFault,
client.CustomDBEngineVersionNotFoundFault,
client.CustomDBEngineVersionQuotaExceededFault,
client.DBClusterAlreadyExistsFault,
client.DBClusterBacktrackNotFoundFault,
client.DBClusterEndpointAlreadyExistsFault,
client.DBClusterEndpointNotFoundFault,
client.DBClusterEndpointQuotaExceededFault,
client.DBClusterNotFoundFault,
client.DBClusterParameterGroupNotFoundFault,
client.DBClusterQuotaExceededFault,
client.DBClusterRoleAlreadyExistsFault,
client.DBClusterRoleNotFoundFault,
client.DBClusterRoleQuotaExceededFault,
client.DBClusterSnapshotAlreadyExistsFault,
client.DBClusterSnapshotNotFoundFault,
client.DBInstanceAlreadyExistsFault,
client.DBInstanceAutomatedBackupNotFoundFault,
client.DBInstanceAutomatedBackupQuotaExceededFault,
client.DBInstanceNotFoundFault,
client.DBInstanceRoleAlreadyExistsFault,
client.DBInstanceRoleNotFoundFault,
client.DBInstanceRoleQuotaExceededFault,
client.DBLogFileNotFoundFault,
client.DBParameterGroupAlreadyExistsFault,
client.DBParameterGroupNotFoundFault,
client.DBParameterGroupQuotaExceededFault,
client.DBProxyAlreadyExistsFault,
client.DBProxyEndpointAlreadyExistsFault,
client.DBProxyEndpointNotFoundFault,
client.DBProxyEndpointQuotaExceededFault,
client.DBProxyNotFoundFault,
client.DBProxyQuotaExceededFault,
client.DBProxyTargetAlreadyRegisteredFault,
client.DBProxyTargetGroupNotFoundFault,
client.DBProxyTargetNotFoundFault,
client.DBSecurityGroupAlreadyExistsFault,
client.DBSecurityGroupNotFoundFault,
client.DBSecurityGroupNotSupportedFault,
client.DBSecurityGroupQuotaExceededFault,
client.DBSnapshotAlreadyExistsFault,
client.DBSnapshotNotFoundFault,
client.DBSubnetGroupAlreadyExistsFault,
client.DBSubnetGroupDoesNotCoverEnoughAZs,
client.DBSubnetGroupNotAllowedFault,
client.DBSubnetGroupNotFoundFault,
client.DBSubnetGroupQuotaExceededFault,
client.DBSubnetQuotaExceededFault,
client.DBUpgradeDependencyFailureFault,
client.DomainNotFoundFault,
client.Ec2ImagePropertiesNotSupportedFault,
client.EventSubscriptionQuotaExceededFault,
client.ExportTaskAlreadyExistsFault,
client.ExportTaskNotFoundFault,
client.GlobalClusterAlreadyExistsFault,
client.GlobalClusterNotFoundFault,
client.GlobalClusterQuotaExceededFault,
client.IamRoleMissingPermissionsFault,
client.IamRoleNotFoundFault,
client.InstanceQuotaExceededFault,
client.InsufficientAvailableIPsInSubnetFault,
client.InsufficientDBClusterCapacityFault,
client.InsufficientDBInstanceCapacityFault,
client.InsufficientStorageClusterCapacityFault,
client.InvalidBlueGreenDeploymentStateFault,
client.InvalidCustomDBEngineVersionStateFault,
client.InvalidDBClusterCapacityFault,
client.InvalidDBClusterEndpointStateFault,
client.InvalidDBClusterSnapshotStateFault,
client.InvalidDBClusterStateFault,
client.InvalidDBInstanceAutomatedBackupStateFault,
client.InvalidDBInstanceStateFault,
client.InvalidDBParameterGroupStateFault,
client.InvalidDBProxyEndpointStateFault,
client.InvalidDBProxyStateFault,
client.InvalidDBSecurityGroupStateFault,
client.InvalidDBSnapshotStateFault,
client.InvalidDBSubnetGroupFault,
client.InvalidDBSubnetGroupStateFault,
client.InvalidDBSubnetStateFault,
client.InvalidEventSubscriptionStateFault,
client.InvalidExportOnlyFault,
client.InvalidExportSourceStateFault,
client.InvalidExportTaskStateFault,
client.InvalidGlobalClusterStateFault,
client.InvalidOptionGroupStateFault,
client.InvalidRestoreFault,
client.InvalidS3BucketFault,
client.InvalidSubnet,
client.InvalidVPCNetworkStateFault,
client.KMSKeyNotAccessibleFault,
client.NetworkTypeNotSupported,
client.OptionGroupAlreadyExistsFault,
client.OptionGroupNotFoundFault,
client.OptionGroupQuotaExceededFault,
client.PointInTimeRestoreNotEnabledFault,
client.ProvisionedIopsNotAvailableInAZFault,
client.ReservedDBInstanceAlreadyExistsFault,
client.ReservedDBInstanceNotFoundFault,
client.ReservedDBInstanceQuotaExceededFault,
client.ReservedDBInstancesOfferingNotFoundFault,
client.ResourceNotFoundFault,
client.SNSInvalidTopicFault,
client.SNSNoAuthorizationFault,
client.SNSTopicArnNotFoundFault,
client.SharedSnapshotQuotaExceededFault,
client.SnapshotQuotaExceededFault,
client.SourceClusterNotSupportedFault,
client.SourceDatabaseNotSupportedFault,
client.SourceNotFoundFault,
client.StorageQuotaExceededFault,
client.StorageTypeNotSupportedFault,
client.SubnetAlreadyInUse,
client.SubscriptionAlreadyExistFault,
client.SubscriptionCategoryNotFoundFault,
client.SubscriptionNotFoundFault,
) as e:
print(e)
from mypy_boto3_rds.client import Exceptions
def handle_error(exc: Exceptions.AuthorizationAlreadyExistsFault) -> None:
...
Methods
add_role_to_db_cluster
Associates an Identity and Access Management (IAM) role with a DB cluster.
Type annotations and code completion for boto3.client("rds").add_role_to_db_cluster
method.
boto3 documentation
def add_role_to_db_cluster(
self,
*,
DBClusterIdentifier: str,
RoleArn: str,
FeatureName: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: AddRoleToDBClusterMessageRequestTypeDef = { # (1)
"DBClusterIdentifier": ...,
"RoleArn": ...,
}
parent.add_role_to_db_cluster(**kwargs)
add_role_to_db_instance
Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.
Type annotations and code completion for boto3.client("rds").add_role_to_db_instance
method.
boto3 documentation
def add_role_to_db_instance(
self,
*,
DBInstanceIdentifier: str,
RoleArn: str,
FeatureName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: AddRoleToDBInstanceMessageRequestTypeDef = { # (1)
"DBInstanceIdentifier": ...,
"RoleArn": ...,
"FeatureName": ...,
}
parent.add_role_to_db_instance(**kwargs)
add_source_identifier_to_subscription
Adds a source identifier to an existing RDS event notification subscription.
Type annotations and code completion for boto3.client("rds").add_source_identifier_to_subscription
method.
boto3 documentation
def add_source_identifier_to_subscription(
self,
*,
SubscriptionName: str,
SourceIdentifier: str,
) -> AddSourceIdentifierToSubscriptionResultTypeDef: # (1)
...
kwargs: AddSourceIdentifierToSubscriptionMessageRequestTypeDef = { # (1)
"SubscriptionName": ...,
"SourceIdentifier": ...,
}
parent.add_source_identifier_to_subscription(**kwargs)
add_tags_to_resource
Adds metadata tags to an Amazon RDS resource.
Type annotations and code completion for boto3.client("rds").add_tags_to_resource
method.
boto3 documentation
def add_tags_to_resource(
self,
*,
ResourceName: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: AddTagsToResourceMessageRequestTypeDef = { # (1)
"ResourceName": ...,
"Tags": ...,
}
parent.add_tags_to_resource(**kwargs)
apply_pending_maintenance_action
Applies a pending maintenance action to a resource (for example, to a DB instance).
Type annotations and code completion for boto3.client("rds").apply_pending_maintenance_action
method.
boto3 documentation
def apply_pending_maintenance_action(
self,
*,
ResourceIdentifier: str,
ApplyAction: str,
OptInType: str,
) -> ApplyPendingMaintenanceActionResultTypeDef: # (1)
...
kwargs: ApplyPendingMaintenanceActionMessageRequestTypeDef = { # (1)
"ResourceIdentifier": ...,
"ApplyAction": ...,
"OptInType": ...,
}
parent.apply_pending_maintenance_action(**kwargs)
authorize_db_security_group_ingress
Enables ingress to a DBSecurityGroup using one of two forms of authorization.
Type annotations and code completion for boto3.client("rds").authorize_db_security_group_ingress
method.
boto3 documentation
def authorize_db_security_group_ingress(
self,
*,
DBSecurityGroupName: str,
CIDRIP: str = ...,
EC2SecurityGroupName: str = ...,
EC2SecurityGroupId: str = ...,
EC2SecurityGroupOwnerId: str = ...,
) -> AuthorizeDBSecurityGroupIngressResultTypeDef: # (1)
...
kwargs: AuthorizeDBSecurityGroupIngressMessageRequestTypeDef = { # (1)
"DBSecurityGroupName": ...,
}
parent.authorize_db_security_group_ingress(**kwargs)
backtrack_db_cluster
Backtracks a DB cluster to a specific time, without creating a new DB cluster.
Type annotations and code completion for boto3.client("rds").backtrack_db_cluster
method.
boto3 documentation
def backtrack_db_cluster(
self,
*,
DBClusterIdentifier: str,
BacktrackTo: Union[datetime, str],
Force: bool = ...,
UseEarliestTimeOnPointInTimeUnavailable: bool = ...,
) -> DBClusterBacktrackResponseMetadataTypeDef: # (1)
...
kwargs: BacktrackDBClusterMessageRequestTypeDef = { # (1)
"DBClusterIdentifier": ...,
"BacktrackTo": ...,
}
parent.backtrack_db_cluster(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("rds").can_paginate
method.
boto3 documentation
cancel_export_task
Cancels an export task in progress that is exporting a snapshot to Amazon S3.
Type annotations and code completion for boto3.client("rds").cancel_export_task
method.
boto3 documentation
def cancel_export_task(
self,
*,
ExportTaskIdentifier: str,
) -> ExportTaskResponseMetadataTypeDef: # (1)
...
kwargs: CancelExportTaskMessageRequestTypeDef = { # (1)
"ExportTaskIdentifier": ...,
}
parent.cancel_export_task(**kwargs)
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("rds").close
method.
boto3 documentation
copy_db_cluster_parameter_group
Copies the specified DB cluster parameter group.
Type annotations and code completion for boto3.client("rds").copy_db_cluster_parameter_group
method.
boto3 documentation
def copy_db_cluster_parameter_group(
self,
*,
SourceDBClusterParameterGroupIdentifier: str,
TargetDBClusterParameterGroupIdentifier: str,
TargetDBClusterParameterGroupDescription: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CopyDBClusterParameterGroupResultTypeDef: # (2)
...
kwargs: CopyDBClusterParameterGroupMessageRequestTypeDef = { # (1)
"SourceDBClusterParameterGroupIdentifier": ...,
"TargetDBClusterParameterGroupIdentifier": ...,
"TargetDBClusterParameterGroupDescription": ...,
}
parent.copy_db_cluster_parameter_group(**kwargs)
copy_db_cluster_snapshot
Copies a snapshot of a DB cluster.
Type annotations and code completion for boto3.client("rds").copy_db_cluster_snapshot
method.
boto3 documentation
def copy_db_cluster_snapshot(
self,
*,
SourceDBClusterSnapshotIdentifier: str,
TargetDBClusterSnapshotIdentifier: str,
KmsKeyId: str = ...,
PreSignedUrl: str = ...,
CopyTags: bool = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
SourceRegion: str = ...,
) -> CopyDBClusterSnapshotResultTypeDef: # (2)
...
kwargs: CopyDBClusterSnapshotMessageRequestTypeDef = { # (1)
"SourceDBClusterSnapshotIdentifier": ...,
"TargetDBClusterSnapshotIdentifier": ...,
}
parent.copy_db_cluster_snapshot(**kwargs)
copy_db_parameter_group
Copies the specified DB parameter group.
Type annotations and code completion for boto3.client("rds").copy_db_parameter_group
method.
boto3 documentation
def copy_db_parameter_group(
self,
*,
SourceDBParameterGroupIdentifier: str,
TargetDBParameterGroupIdentifier: str,
TargetDBParameterGroupDescription: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CopyDBParameterGroupResultTypeDef: # (2)
...
kwargs: CopyDBParameterGroupMessageRequestTypeDef = { # (1)
"SourceDBParameterGroupIdentifier": ...,
"TargetDBParameterGroupIdentifier": ...,
"TargetDBParameterGroupDescription": ...,
}
parent.copy_db_parameter_group(**kwargs)
copy_db_snapshot
Copies the specified DB snapshot.
Type annotations and code completion for boto3.client("rds").copy_db_snapshot
method.
boto3 documentation
def copy_db_snapshot(
self,
*,
SourceDBSnapshotIdentifier: str,
TargetDBSnapshotIdentifier: str,
KmsKeyId: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
CopyTags: bool = ...,
PreSignedUrl: str = ...,
OptionGroupName: str = ...,
TargetCustomAvailabilityZone: str = ...,
CopyOptionGroup: bool = ...,
SourceRegion: str = ...,
) -> CopyDBSnapshotResultTypeDef: # (2)
...
kwargs: CopyDBSnapshotMessageRequestTypeDef = { # (1)
"SourceDBSnapshotIdentifier": ...,
"TargetDBSnapshotIdentifier": ...,
}
parent.copy_db_snapshot(**kwargs)
copy_option_group
Copies the specified option group.
Type annotations and code completion for boto3.client("rds").copy_option_group
method.
boto3 documentation
def copy_option_group(
self,
*,
SourceOptionGroupIdentifier: str,
TargetOptionGroupIdentifier: str,
TargetOptionGroupDescription: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CopyOptionGroupResultTypeDef: # (2)
...
kwargs: CopyOptionGroupMessageRequestTypeDef = { # (1)
"SourceOptionGroupIdentifier": ...,
"TargetOptionGroupIdentifier": ...,
"TargetOptionGroupDescription": ...,
}
parent.copy_option_group(**kwargs)
create_blue_green_deployment
Creates a blue/green deployment.
Type annotations and code completion for boto3.client("rds").create_blue_green_deployment
method.
boto3 documentation
def create_blue_green_deployment(
self,
*,
BlueGreenDeploymentName: str,
Source: str,
TargetEngineVersion: str = ...,
TargetDBParameterGroupName: str = ...,
TargetDBClusterParameterGroupName: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateBlueGreenDeploymentResponseTypeDef: # (2)
...
kwargs: CreateBlueGreenDeploymentRequestRequestTypeDef = { # (1)
"BlueGreenDeploymentName": ...,
"Source": ...,
}
parent.create_blue_green_deployment(**kwargs)
create_custom_db_engine_version
Creates a custom DB engine version (CEV).
Type annotations and code completion for boto3.client("rds").create_custom_db_engine_version
method.
boto3 documentation
def create_custom_db_engine_version(
self,
*,
Engine: str,
EngineVersion: str,
DatabaseInstallationFilesS3BucketName: str = ...,
DatabaseInstallationFilesS3Prefix: str = ...,
ImageId: str = ...,
KMSKeyId: str = ...,
Description: str = ...,
Manifest: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> DBEngineVersionResponseMetadataTypeDef: # (2)
...
kwargs: CreateCustomDBEngineVersionMessageRequestTypeDef = { # (1)
"Engine": ...,
"EngineVersion": ...,
}
parent.create_custom_db_engine_version(**kwargs)
create_db_cluster
Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
Type annotations and code completion for boto3.client("rds").create_db_cluster
method.
boto3 documentation
def create_db_cluster(
self,
*,
DBClusterIdentifier: str,
Engine: str,
AvailabilityZones: Sequence[str] = ...,
BackupRetentionPeriod: int = ...,
CharacterSetName: str = ...,
DatabaseName: str = ...,
DBClusterParameterGroupName: str = ...,
VpcSecurityGroupIds: Sequence[str] = ...,
DBSubnetGroupName: str = ...,
EngineVersion: str = ...,
Port: int = ...,
MasterUsername: str = ...,
MasterUserPassword: str = ...,
OptionGroupName: str = ...,
PreferredBackupWindow: str = ...,
PreferredMaintenanceWindow: str = ...,
ReplicationSourceIdentifier: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
StorageEncrypted: bool = ...,
KmsKeyId: str = ...,
PreSignedUrl: str = ...,
EnableIAMDatabaseAuthentication: bool = ...,
BacktrackWindow: int = ...,
EnableCloudwatchLogsExports: Sequence[str] = ...,
EngineMode: str = ...,
ScalingConfiguration: ScalingConfigurationTypeDef = ..., # (2)
DeletionProtection: bool = ...,
GlobalClusterIdentifier: str = ...,
EnableHttpEndpoint: bool = ...,
CopyTagsToSnapshot: bool = ...,
Domain: str = ...,
DomainIAMRoleName: str = ...,
EnableGlobalWriteForwarding: bool = ...,
DBClusterInstanceClass: str = ...,
AllocatedStorage: int = ...,
StorageType: str = ...,
Iops: int = ...,
PubliclyAccessible: bool = ...,
AutoMinorVersionUpgrade: bool = ...,
MonitoringInterval: int = ...,
MonitoringRoleArn: str = ...,
EnablePerformanceInsights: bool = ...,
PerformanceInsightsKMSKeyId: str = ...,
PerformanceInsightsRetentionPeriod: int = ...,
ServerlessV2ScalingConfiguration: ServerlessV2ScalingConfigurationTypeDef = ..., # (3)
NetworkType: str = ...,
DBSystemId: str = ...,
ManageMasterUserPassword: bool = ...,
MasterUserSecretKmsKeyId: str = ...,
SourceRegion: str = ...,
) -> CreateDBClusterResultTypeDef: # (4)
...
- See TagTypeDef
- See ScalingConfigurationTypeDef
- See ServerlessV2ScalingConfigurationTypeDef
- See CreateDBClusterResultTypeDef
kwargs: CreateDBClusterMessageRequestTypeDef = { # (1)
"DBClusterIdentifier": ...,
"Engine": ...,
}
parent.create_db_cluster(**kwargs)
create_db_cluster_endpoint
Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.
Type annotations and code completion for boto3.client("rds").create_db_cluster_endpoint
method.
boto3 documentation
def create_db_cluster_endpoint(
self,
*,
DBClusterIdentifier: str,
DBClusterEndpointIdentifier: str,
EndpointType: str,
StaticMembers: Sequence[str] = ...,
ExcludedMembers: Sequence[str] = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> DBClusterEndpointResponseMetadataTypeDef: # (2)
...
kwargs: CreateDBClusterEndpointMessageRequestTypeDef = { # (1)
"DBClusterIdentifier": ...,
"DBClusterEndpointIdentifier": ...,
"EndpointType": ...,
}
parent.create_db_cluster_endpoint(**kwargs)
create_db_cluster_parameter_group
Creates a new DB cluster parameter group.
Type annotations and code completion for boto3.client("rds").create_db_cluster_parameter_group
method.
boto3 documentation
def create_db_cluster_parameter_group(
self,
*,
DBClusterParameterGroupName: str,
DBParameterGroupFamily: str,
Description: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateDBClusterParameterGroupResultTypeDef: # (2)
...
kwargs: CreateDBClusterParameterGroupMessageRequestTypeDef = { # (1)
"DBClusterParameterGroupName": ...,
"DBParameterGroupFamily": ...,
"Description": ...,
}
parent.create_db_cluster_parameter_group(**kwargs)
create_db_cluster_snapshot
Creates a snapshot of a DB cluster.
Type annotations and code completion for boto3.client("rds").create_db_cluster_snapshot
method.
boto3 documentation
def create_db_cluster_snapshot(
self,
*,
DBClusterSnapshotIdentifier: str,
DBClusterIdentifier: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateDBClusterSnapshotResultTypeDef: # (2)
...
kwargs: CreateDBClusterSnapshotMessageRequestTypeDef = { # (1)
"DBClusterSnapshotIdentifier": ...,
"DBClusterIdentifier": ...,
}
parent.create_db_cluster_snapshot(**kwargs)
create_db_instance
Creates a new DB instance.
Type annotations and code completion for boto3.client("rds").create_db_instance
method.
boto3 documentation
def create_db_instance(
self,
*,
DBInstanceIdentifier: str,
DBInstanceClass: str,
Engine: str,
DBName: str = ...,
AllocatedStorage: int = ...,
MasterUsername: str = ...,
MasterUserPassword: str = ...,
DBSecurityGroups: Sequence[str] = ...,
VpcSecurityGroupIds: Sequence[str] = ...,
AvailabilityZone: str = ...,
DBSubnetGroupName: str = ...,
PreferredMaintenanceWindow: str = ...,
DBParameterGroupName: str = ...,
BackupRetentionPeriod: int = ...,
PreferredBackupWindow: str = ...,
Port: int = ...,
MultiAZ: bool = ...,
EngineVersion: str = ...,
AutoMinorVersionUpgrade: bool = ...,
LicenseModel: str = ...,
Iops: int = ...,
OptionGroupName: str = ...,
CharacterSetName: str = ...,
NcharCharacterSetName: str = ...,
PubliclyAccessible: bool = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
DBClusterIdentifier: str = ...,
StorageType: str = ...,
TdeCredentialArn: str = ...,
TdeCredentialPassword: str = ...,
StorageEncrypted: bool = ...,
KmsKeyId: str = ...,
Domain: str = ...,
CopyTagsToSnapshot: bool = ...,
MonitoringInterval: int = ...,
MonitoringRoleArn: str = ...,
DomainIAMRoleName: str = ...,
PromotionTier: int = ...,
Timezone: str = ...,
EnableIAMDatabaseAuthentication: bool = ...,
EnablePerformanceInsights: bool = ...,
PerformanceInsightsKMSKeyId: str = ...,
PerformanceInsightsRetentionPeriod: int = ...,
EnableCloudwatchLogsExports: Sequence[str] = ...,
ProcessorFeatures: Sequence[ProcessorFeatureTypeDef] = ..., # (2)
DeletionProtection: bool = ...,
MaxAllocatedStorage: int = ...,
EnableCustomerOwnedIp: bool = ...,
CustomIamInstanceProfile: str = ...,
BackupTarget: str = ...,
NetworkType: str = ...,
StorageThroughput: int = ...,
ManageMasterUserPassword: bool = ...,
MasterUserSecretKmsKeyId: str = ...,
CACertificateIdentifier: str = ...,
) -> CreateDBInstanceResultTypeDef: # (3)
...
kwargs: CreateDBInstanceMessageRequestTypeDef = { # (1)
"DBInstanceIdentifier": ...,
"DBInstanceClass": ...,
"Engine": ...,
}
parent.create_db_instance(**kwargs)
create_db_instance_read_replica
Creates a new DB instance that acts as a read replica for an existing source DB instance.
Type annotations and code completion for boto3.client("rds").create_db_instance_read_replica
method.
boto3 documentation
def create_db_instance_read_replica(
self,
*,
DBInstanceIdentifier: str,
SourceDBInstanceIdentifier: str,
DBInstanceClass: str = ...,
AvailabilityZone: str = ...,
Port: int = ...,
MultiAZ: bool = ...,
AutoMinorVersionUpgrade: bool = ...,
Iops: int = ...,
OptionGroupName: str = ...,
DBParameterGroupName: str = ...,
PubliclyAccessible: bool = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
DBSubnetGroupName: str = ...,
VpcSecurityGroupIds: Sequence[str] = ...,
StorageType: str = ...,
CopyTagsToSnapshot: bool = ...,
MonitoringInterval: int = ...,
MonitoringRoleArn: str = ...,
KmsKeyId: str = ...,
PreSignedUrl: str = ...,
EnableIAMDatabaseAuthentication: bool = ...,
EnablePerformanceInsights: bool = ...,
PerformanceInsightsKMSKeyId: str = ...,
PerformanceInsightsRetentionPeriod: int = ...,
EnableCloudwatchLogsExports: Sequence[str] = ...,
ProcessorFeatures: Sequence[ProcessorFeatureTypeDef] = ..., # (2)
UseDefaultProcessorFeatures: bool = ...,
DeletionProtection: bool = ...,
Domain: str = ...,
DomainIAMRoleName: str = ...,
ReplicaMode: ReplicaModeType = ..., # (3)
MaxAllocatedStorage: int = ...,
CustomIamInstanceProfile: str = ...,
NetworkType: str = ...,
StorageThroughput: int = ...,
EnableCustomerOwnedIp: bool = ...,
AllocatedStorage: int = ...,
SourceRegion: str = ...,
) -> CreateDBInstanceReadReplicaResultTypeDef: # (4)
...
- See TagTypeDef
- See ProcessorFeatureTypeDef
- See ReplicaModeType
- See CreateDBInstanceReadReplicaResultTypeDef
kwargs: CreateDBInstanceReadReplicaMessageRequestTypeDef = { # (1)
"DBInstanceIdentifier": ...,
"SourceDBInstanceIdentifier": ...,
}
parent.create_db_instance_read_replica(**kwargs)
create_db_parameter_group
Creates a new DB parameter group.
Type annotations and code completion for boto3.client("rds").create_db_parameter_group
method.
boto3 documentation
def create_db_parameter_group(
self,
*,
DBParameterGroupName: str,
DBParameterGroupFamily: str,
Description: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateDBParameterGroupResultTypeDef: # (2)
...
kwargs: CreateDBParameterGroupMessageRequestTypeDef = { # (1)
"DBParameterGroupName": ...,
"DBParameterGroupFamily": ...,
"Description": ...,
}
parent.create_db_parameter_group(**kwargs)
create_db_proxy
Creates a new DB proxy.
Type annotations and code completion for boto3.client("rds").create_db_proxy
method.
boto3 documentation
def create_db_proxy(
self,
*,
DBProxyName: str,
EngineFamily: EngineFamilyType, # (1)
Auth: Sequence[UserAuthConfigTypeDef], # (2)
RoleArn: str,
VpcSubnetIds: Sequence[str],
VpcSecurityGroupIds: Sequence[str] = ...,
RequireTLS: bool = ...,
IdleClientTimeout: int = ...,
DebugLogging: bool = ...,
Tags: Sequence[TagTypeDef] = ..., # (3)
) -> CreateDBProxyResponseTypeDef: # (4)
...
- See EngineFamilyType
- See UserAuthConfigTypeDef
- See TagTypeDef
- See CreateDBProxyResponseTypeDef
kwargs: CreateDBProxyRequestRequestTypeDef = { # (1)
"DBProxyName": ...,
"EngineFamily": ...,
"Auth": ...,
"RoleArn": ...,
"VpcSubnetIds": ...,
}
parent.create_db_proxy(**kwargs)
create_db_proxy_endpoint
Creates a DBProxyEndpoint
.
Type annotations and code completion for boto3.client("rds").create_db_proxy_endpoint
method.
boto3 documentation
def create_db_proxy_endpoint(
self,
*,
DBProxyName: str,
DBProxyEndpointName: str,
VpcSubnetIds: Sequence[str],
VpcSecurityGroupIds: Sequence[str] = ...,
TargetRole: DBProxyEndpointTargetRoleType = ..., # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateDBProxyEndpointResponseTypeDef: # (3)
...
kwargs: CreateDBProxyEndpointRequestRequestTypeDef = { # (1)
"DBProxyName": ...,
"DBProxyEndpointName": ...,
"VpcSubnetIds": ...,
}
parent.create_db_proxy_endpoint(**kwargs)
create_db_security_group
Creates a new DB security group.
Type annotations and code completion for boto3.client("rds").create_db_security_group
method.
boto3 documentation
def create_db_security_group(
self,
*,
DBSecurityGroupName: str,
DBSecurityGroupDescription: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateDBSecurityGroupResultTypeDef: # (2)
...
kwargs: CreateDBSecurityGroupMessageRequestTypeDef = { # (1)
"DBSecurityGroupName": ...,
"DBSecurityGroupDescription": ...,
}
parent.create_db_security_group(**kwargs)
create_db_snapshot
Creates a snapshot of a DB instance.
Type annotations and code completion for boto3.client("rds").create_db_snapshot
method.
boto3 documentation
def create_db_snapshot(
self,
*,
DBSnapshotIdentifier: str,
DBInstanceIdentifier: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateDBSnapshotResultTypeDef: # (2)
...
kwargs: CreateDBSnapshotMessageRequestTypeDef = { # (1)
"DBSnapshotIdentifier": ...,
"DBInstanceIdentifier": ...,
}
parent.create_db_snapshot(**kwargs)
create_db_subnet_group
Creates a new DB subnet group.
Type annotations and code completion for boto3.client("rds").create_db_subnet_group
method.
boto3 documentation
def create_db_subnet_group(
self,
*,
DBSubnetGroupName: str,
DBSubnetGroupDescription: str,
SubnetIds: Sequence[str],
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateDBSubnetGroupResultTypeDef: # (2)
...
kwargs: CreateDBSubnetGroupMessageRequestTypeDef = { # (1)
"DBSubnetGroupName": ...,
"DBSubnetGroupDescription": ...,
"SubnetIds": ...,
}
parent.create_db_subnet_group(**kwargs)
create_event_subscription
Creates an RDS event notification subscription.
Type annotations and code completion for boto3.client("rds").create_event_subscription
method.
boto3 documentation
def create_event_subscription(
self,
*,
SubscriptionName: str,
SnsTopicArn: str,
SourceType: str = ...,
EventCategories: Sequence[str] = ...,
SourceIds: Sequence[str] = ...,
Enabled: bool = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateEventSubscriptionResultTypeDef: # (2)
...