rds
library
Classes
Certificate
Provides a resource to override the system-default SSL/TLS certificate for Amazon RDS for new DB instances in the current AWS region.
CertificateArgs
The set of arguments for Certificate.
The set of arguments for Certificate.
CertificateState
Input properties used for looking up and filtering Certificate resources.
Cluster
Manages a RDS Aurora Cluster or a RDS Multi-AZ DB Cluster . To manage cluster instances that inherit configuration from the cluster (when not running the cluster in serverless engine mode), see the aws.rds.ClusterInstance resource. To manage non-Aurora DB instances (e.g., MySQL, PostgreSQL, SQL Server, etc.), see the aws.rds.Instance resource.
ClusterActivityStream
Manages RDS Aurora Cluster Database Activity Streams.
ClusterActivityStreamArgs
The set of arguments for ClusterActivityStream.
The set of arguments for ClusterActivityStream.
ClusterActivityStreamState
Input properties used for looking up and filtering ClusterActivityStream resources.
ClusterArgs
The set of arguments for Cluster.
The set of arguments for Cluster.
ClusterEndpoint
Manages an RDS Aurora Cluster Custom Endpoint.
You can refer to the User Guide .
ClusterEndpointArgs
The set of arguments for ClusterEndpoint.
The set of arguments for ClusterEndpoint.
ClusterEndpointState
Input properties used for looking up and filtering ClusterEndpoint resources.
ClusterInstance
Provides an RDS Cluster Instance Resource. A Cluster Instance Resource defines
attributes that are specific to a single instance in a RDS Cluster,
specifically running Amazon Aurora.
ClusterInstanceArgs
The set of arguments for ClusterInstance.
The set of arguments for ClusterInstance.
ClusterInstanceState
Input properties used for looking up and filtering ClusterInstance resources.
ClusterMasterUserSecret
ClusterParameterGroup
Provides an RDS DB cluster parameter group resource. Documentation of the available parameters for various Aurora engines can be found at:
ClusterParameterGroupArgs
The set of arguments for ClusterParameterGroup.
The set of arguments for ClusterParameterGroup.
ClusterParameterGroupParameter
ClusterParameterGroupState
Input properties used for looking up and filtering ClusterParameterGroup resources.
ClusterRestoreToPointInTime
ClusterRoleAssociation
Manages a RDS DB Cluster association with an IAM Role. Example use cases:
ClusterRoleAssociationArgs
The set of arguments for ClusterRoleAssociation.
The set of arguments for ClusterRoleAssociation.
ClusterRoleAssociationState
Input properties used for looking up and filtering ClusterRoleAssociation resources.
ClusterS3Import
ClusterScalingConfiguration
ClusterServerlessv2ScalingConfiguration
ClusterSnapshot
Manages an RDS database cluster snapshot for Aurora clusters. For managing RDS database instance snapshots, see the aws.rds.Snapshot resource.
ClusterSnapshotArgs
The set of arguments for ClusterSnapshot.
The set of arguments for ClusterSnapshot.
ClusterSnapshotCopy
Manages an RDS database cluster snapshot copy. For managing RDS database instance snapshot copies, see the aws.rds.SnapshotCopy resource.
ClusterSnapshotCopyArgs
The set of arguments for ClusterSnapshotCopy.
The set of arguments for ClusterSnapshotCopy.
ClusterSnapshotCopyState
Input properties used for looking up and filtering ClusterSnapshotCopy resources.
ClusterSnapshotCopyTimeouts
ClusterSnapshotState
Input properties used for looking up and filtering ClusterSnapshot resources.
ClusterState
Input properties used for looking up and filtering Cluster resources.
CustomDbEngineVersion
Provides an custom engine version (CEV) resource for Amazon RDS Custom. For additional information, see Working with CEVs for RDS Custom for Oracle and Working with CEVs for RDS Custom for SQL Server in the the RDS User Guide .
CustomDbEngineVersionArgs
The set of arguments for CustomDbEngineVersion.
The set of arguments for CustomDbEngineVersion.
CustomDbEngineVersionState
Input properties used for looking up and filtering CustomDbEngineVersion resources.
EventSubscription
Provides a DB event subscription resource.
EventSubscriptionArgs
The set of arguments for EventSubscription.
The set of arguments for EventSubscription.
EventSubscriptionState
Input properties used for looking up and filtering EventSubscription resources.
ExportTask
Resource for managing an AWS RDS (Relational Database) Export Task.
ExportTaskArgs
The set of arguments for ExportTask.
The set of arguments for ExportTask.
ExportTaskState
Input properties used for looking up and filtering ExportTask resources.
ExportTaskTimeouts
GetCertificateArgs
Arguments for getCertificate.
Arguments for getCertificate.
GetCertificateResult
Result data returned by getCertificate.
GetClusterArgs
Arguments for getCluster.
Arguments for getCluster.
GetClusterMasterUserSecret
GetClusterParameterGroupArgs
Arguments for getClusterParameterGroup.
Arguments for getClusterParameterGroup.
GetClusterParameterGroupResult
Result data returned by getClusterParameterGroup.
GetClusterResult
Result data returned by getCluster.
GetClustersArgs
Arguments for getClusters.
Arguments for getClusters.
GetClustersFilter
GetClusterSnapshotArgs
Arguments for getClusterSnapshot.
Arguments for getClusterSnapshot.
GetClusterSnapshotResult
Result data returned by getClusterSnapshot.
GetClustersResult
Result data returned by getClusters.
GetEngineVersionArgs
Arguments for getEngineVersion.
Arguments for getEngineVersion.
GetEngineVersionFilter
GetEngineVersionResult
Result data returned by getEngineVersion.
GetEventCategoriesArgs
Arguments for getEventCategories.
Arguments for getEventCategories.
GetEventCategoriesResult
Result data returned by getEventCategories.
GetGlobalClusterArgs
Arguments for getGlobalCluster.
Arguments for getGlobalCluster.
GetGlobalClusterMember
GetGlobalClusterResult
Result data returned by getGlobalCluster.
GetInstanceArgs
Arguments for getInstance.
Arguments for getInstance.
GetInstanceMasterUserSecret
GetInstanceResult
Result data returned by getInstance.
GetInstancesArgs
Arguments for getInstances.
Arguments for getInstances.
GetInstancesFilter
GetInstancesResult
Result data returned by getInstances.
GetOrderableDbInstanceArgs
Arguments for getOrderableDbInstance.
Arguments for getOrderableDbInstance.
GetOrderableDbInstanceResult
Result data returned by getOrderableDbInstance.
GetParameterGroupArgs
Arguments for getParameterGroup.
Arguments for getParameterGroup.
GetParameterGroupResult
Result data returned by getParameterGroup.
GetProxyArgs
Arguments for getProxy.
Arguments for getProxy.
GetProxyAuth
GetProxyResult
Result data returned by getProxy.
GetReservedInstanceOfferingArgs
Arguments for getReservedInstanceOffering.
Arguments for getReservedInstanceOffering.
GetReservedInstanceOfferingResult
Result data returned by getReservedInstanceOffering.
GetSnapshotArgs
Arguments for getSnapshot.
Arguments for getSnapshot.
GetSnapshotResult
Result data returned by getSnapshot.
GetSnapshotsArgs
Arguments for getSnapshots.
Arguments for getSnapshots.
GetSnapshotsFilter
GetSnapshotsResult
Result data returned by getSnapshots.
GetSnapshotsSnapshot
GetSnapshotsSnapshotTagList
GetSubnetGroupArgs
Arguments for getSubnetGroup.
Arguments for getSubnetGroup.
GetSubnetGroupResult
Result data returned by getSubnetGroup.
GlobalCluster
Manages an RDS Global Cluster, which is an Aurora global database spread across multiple regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.
GlobalClusterArgs
The set of arguments for GlobalCluster.
The set of arguments for GlobalCluster.
GlobalClusterGlobalClusterMember
GlobalClusterState
Input properties used for looking up and filtering GlobalCluster resources.
Instance
Provides an RDS instance resource. A DB instance is an isolated database
environment in the cloud. A DB instance can contain multiple user-created
databases.
InstanceArgs
The set of arguments for Instance.
The set of arguments for Instance.
InstanceAutomatedBackupsReplication
Manage cross-region replication of automated backups to a different AWS Region. Documentation for cross-region automated backup replication can be found at:
InstanceAutomatedBackupsReplicationArgs
The set of arguments for InstanceAutomatedBackupsReplication.
The set of arguments for InstanceAutomatedBackupsReplication.
InstanceAutomatedBackupsReplicationState
Input properties used for looking up and filtering InstanceAutomatedBackupsReplication resources.
InstanceBlueGreenUpdate
InstanceDesiredState
Resource for managing an AWS RDS (Relational Database) RDS Instance State.
InstanceDesiredStateArgs
The set of arguments for InstanceDesiredState.
The set of arguments for InstanceDesiredState.
InstanceDesiredStateState
Input properties used for looking up and filtering InstanceDesiredState resources.
InstanceDesiredStateTimeouts
InstanceListenerEndpoint
InstanceMasterUserSecret
InstanceRestoreToPointInTime
InstanceS3Import
InstanceState
Input properties used for looking up and filtering Instance resources.
Integration
Resource for managing an AWS RDS (Relational Database) zero-ETL integration. You can refer to the User Guide .
IntegrationArgs
The set of arguments for Integration.
The set of arguments for Integration.
IntegrationState
Input properties used for looking up and filtering Integration resources.
IntegrationTimeouts
OptionGroup
Provides an RDS DB option group resource. Documentation of the available options for various RDS engines can be found at:
OptionGroupArgs
The set of arguments for OptionGroup.
The set of arguments for OptionGroup.
OptionGroupOption
OptionGroupOptionOptionSetting
OptionGroupState
Input properties used for looking up and filtering OptionGroup resources.
ParameterGroup
Provides an RDS DB parameter group resource. Documentation of the available parameters for various RDS engines can be found at:
ParameterGroupArgs
The set of arguments for ParameterGroup.
The set of arguments for ParameterGroup.
ParameterGroupParameter
ParameterGroupState
Input properties used for looking up and filtering ParameterGroup resources.
Proxy
Provides an RDS DB proxy resource. For additional information, see the RDS User Guide .
ProxyArgs
The set of arguments for Proxy.
The set of arguments for Proxy.
ProxyAuth
ProxyDefaultTargetGroup
Provides a resource to manage an RDS DB proxy default target group resource.
ProxyDefaultTargetGroupArgs
The set of arguments for ProxyDefaultTargetGroup.
The set of arguments for ProxyDefaultTargetGroup.
ProxyDefaultTargetGroupConnectionPoolConfig
ProxyDefaultTargetGroupState
Input properties used for looking up and filtering ProxyDefaultTargetGroup resources.
ProxyEndpoint
Provides an RDS DB proxy endpoint resource. For additional information, see the RDS User Guide .
ProxyEndpointArgs
The set of arguments for ProxyEndpoint.
The set of arguments for ProxyEndpoint.
ProxyEndpointState
Input properties used for looking up and filtering ProxyEndpoint resources.
ProxyState
Input properties used for looking up and filtering Proxy resources.
ProxyTarget
Provides an RDS DB proxy target resource.
ProxyTargetArgs
The set of arguments for ProxyTarget.
The set of arguments for ProxyTarget.
ProxyTargetState
Input properties used for looking up and filtering ProxyTarget resources.
ReservedInstance
Manages an RDS DB Reserved Instance.
ReservedInstanceArgs
The set of arguments for ReservedInstance.
The set of arguments for ReservedInstance.
ReservedInstanceRecurringCharge
ReservedInstanceState
Input properties used for looking up and filtering ReservedInstance resources.
RoleAssociation
Manages an RDS DB Instance association with an IAM Role. Example use cases:
RoleAssociationArgs
The set of arguments for RoleAssociation.
The set of arguments for RoleAssociation.
RoleAssociationState
Input properties used for looking up and filtering RoleAssociation resources.
ShardGroup
Resource for managing an Amazon Aurora Limitless Database DB shard group
ShardGroupArgs
The set of arguments for ShardGroup.
The set of arguments for ShardGroup.
ShardGroupState
Input properties used for looking up and filtering ShardGroup resources.
ShardGroupTimeouts
Snapshot
Manages an RDS database instance snapshot. For managing RDS database cluster snapshots, see the aws.rds.ClusterSnapshot resource.
SnapshotArgs
The set of arguments for Snapshot.
The set of arguments for Snapshot.
SnapshotCopy
Manages an RDS database instance snapshot copy. For managing RDS database cluster snapshots, see the aws.rds.ClusterSnapshot resource.
SnapshotCopyArgs
The set of arguments for SnapshotCopy.
The set of arguments for SnapshotCopy.
SnapshotCopyState
Input properties used for looking up and filtering SnapshotCopy resources.
SnapshotState
Input properties used for looking up and filtering Snapshot resources.
SubnetGroup
Provides an RDS DB subnet group resource.
SubnetGroupArgs
The set of arguments for SubnetGroup.
The set of arguments for SubnetGroup.
SubnetGroupState
Input properties used for looking up and filtering SubnetGroup resources.
Functions
getCertificate (GetCertificateArgs args , {InvokeOptions? options })
→ Future <GetCertificateResult >
Information about an RDS Certificate.
getCertificateOutput (GetCertificateArgs args , {InvokeOutputOptions? options })
→ Output<GetCertificateResult >
getCluster (GetClusterArgs args , {InvokeOptions? options })
→ Future <GetClusterResult >
Provides information about an RDS cluster.
getClusterOutput (GetClusterArgs args , {InvokeOutputOptions? options })
→ Output<GetClusterResult >
getClusterParameterGroup (GetClusterParameterGroupArgs args , {InvokeOptions? options })
→ Future <GetClusterParameterGroupResult >
Information about an RDS cluster parameter group.
getClusterParameterGroupOutput (GetClusterParameterGroupArgs args , {InvokeOutputOptions? options })
→ Output<GetClusterParameterGroupResult >
getClusters (GetClustersArgs args , {InvokeOptions? options })
→ Future <GetClustersResult >
Data source for managing an AWS RDS (Relational Database) Clusters.
getClusterSnapshot (GetClusterSnapshotArgs args , {InvokeOptions? options })
→ Future <GetClusterSnapshotResult >
Use this data source to get information about a DB Cluster Snapshot for use when provisioning DB clusters.
getClusterSnapshotOutput (GetClusterSnapshotArgs args , {InvokeOutputOptions? options })
→ Output<GetClusterSnapshotResult >
getClustersOutput (GetClustersArgs args , {InvokeOutputOptions? options })
→ Output<GetClustersResult >
getEngineVersion (GetEngineVersionArgs args , {InvokeOptions? options })
→ Future <GetEngineVersionResult >
Information about an RDS engine version.
getEngineVersionOutput (GetEngineVersionArgs args , {InvokeOutputOptions? options })
→ Output<GetEngineVersionResult >
getEventCategories (GetEventCategoriesArgs args , {InvokeOptions? options })
→ Future <GetEventCategoriesResult >
Example Usage
getEventCategoriesOutput (GetEventCategoriesArgs args , {InvokeOutputOptions? options })
→ Output<GetEventCategoriesResult >
getGlobalCluster (GetGlobalClusterArgs args , {InvokeOptions? options })
→ Future <GetGlobalClusterResult >
Data source for managing an AWS RDS (Relational Database) Global Cluster.
getGlobalClusterOutput (GetGlobalClusterArgs args , {InvokeOutputOptions? options })
→ Output<GetGlobalClusterResult >
getInstance (GetInstanceArgs args , {InvokeOptions? options })
→ Future <GetInstanceResult >
Use this data source to get information about an RDS instance
getInstanceOutput (GetInstanceArgs args , {InvokeOutputOptions? options })
→ Output<GetInstanceResult >
getInstances (GetInstancesArgs args , {InvokeOptions? options })
→ Future <GetInstancesResult >
Data source for listing RDS Database Instances.
getInstancesOutput (GetInstancesArgs args , {InvokeOutputOptions? options })
→ Output<GetInstancesResult >
getOrderableDbInstance (GetOrderableDbInstanceArgs args , {InvokeOptions? options })
→ Future <GetOrderableDbInstanceResult >
Information about RDS orderable DB instances and valid parameter combinations.
getOrderableDbInstanceOutput (GetOrderableDbInstanceArgs args , {InvokeOutputOptions? options })
→ Output<GetOrderableDbInstanceResult >
getParameterGroup (GetParameterGroupArgs args , {InvokeOptions? options })
→ Future <GetParameterGroupResult >
Information about a database parameter group.
getParameterGroupOutput (GetParameterGroupArgs args , {InvokeOutputOptions? options })
→ Output<GetParameterGroupResult >
getProxy (GetProxyArgs args , {InvokeOptions? options })
→ Future <GetProxyResult >
Use this data source to get information about a DB Proxy.
getProxyOutput (GetProxyArgs args , {InvokeOutputOptions? options })
→ Output<GetProxyResult >
getReservedInstanceOffering (GetReservedInstanceOfferingArgs args , {InvokeOptions? options })
→ Future <GetReservedInstanceOfferingResult >
Information about a single RDS Reserved Instance Offering.
getReservedInstanceOfferingOutput (GetReservedInstanceOfferingArgs args , {InvokeOutputOptions? options })
→ Output<GetReservedInstanceOfferingResult >
getSnapshot (GetSnapshotArgs args , {InvokeOptions? options })
→ Future <GetSnapshotResult >
Use this data source to get information about a DB Snapshot for use when provisioning DB instances
getSnapshotOutput (GetSnapshotArgs args , {InvokeOutputOptions? options })
→ Output<GetSnapshotResult >
getSnapshots (GetSnapshotsArgs args , {InvokeOptions? options })
→ Future <GetSnapshotsResult >
Provides details about an AWS RDS (Relational Database) Snapshots.
getSnapshotsOutput (GetSnapshotsArgs args , {InvokeOutputOptions? options })
→ Output<GetSnapshotsResult >
getSubnetGroup (GetSubnetGroupArgs args , {InvokeOptions? options })
→ Future <GetSubnetGroupResult >
Use this data source to get information about an RDS subnet group.
getSubnetGroupOutput (GetSubnetGroupArgs args , {InvokeOutputOptions? options })
→ Output<GetSubnetGroupResult >