pulumi-aws-native-kotlin/com.pulumi.awsnative.rds.kotlin

Package-level declarations

Types

class CustomDbEngineVersion : KotlinCustomResource

The AWS::RDS::CustomDBEngineVersion resource creates an Amazon RDS custom DB engine version.

data class CustomDbEngineVersionArgs(val databaseInstallationFilesS3BucketName: Output<String>? = null, val databaseInstallationFilesS3Prefix: Output<String>? = null, val description: Output<String>? = null, val engine: Output<String>? = null, val engineVersion: Output<String>? = null, val imageId: Output<String>? = null, val kmsKeyId: Output<String>? = null, val manifest: Output<String>? = null, val sourceCustomDbEngineVersionIdentifier: Output<String>? = null, val status: Output<CustomDbEngineVersionStatus>? = null, val tags: Output<List<TagArgs>>? = null, val useAwsProvidedLatestImage: Output<Boolean>? = null) : ConvertibleToJava<CustomDbEngineVersionArgs>

The AWS::RDS::CustomDBEngineVersion resource creates an Amazon RDS custom DB engine version.

CustomDbEngineVersionArgsBuilder

class CustomDbEngineVersionArgsBuilder

Builder for CustomDbEngineVersionArgs.

CustomDbEngineVersionMapper

object CustomDbEngineVersionMapper : ResourceMapper<CustomDbEngineVersion>

CustomDbEngineVersionResourceBuilder

class CustomDbEngineVersionResourceBuilder

Builder for CustomDbEngineVersion.

DbCluster

class DbCluster : KotlinCustomResource

The `AWS::RDS::DBCluster` resource creates an Amazon Aurora DB cluster or Multi-AZ DB cluster. For more information about creating an Aurora DB cluster, see Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide. For more information about creating a Multi-AZ DB cluster, see Creating a Multi-AZ DB cluster in the Amazon RDS User Guide. You can only create this resource in AWS Regions where Amazon Aurora or Multi-AZ DB clusters are supported. Updating DB clusters When properties labeled "Update requires: Replacement" are updated, AWS CloudFormation first creates a replacement DB cluster, then changes references from other dependent resources to point to the replacement DB cluster, and finally deletes the old DB cluster. We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB cluster. To preserve your data, perform the following procedure:

DbClusterArgs

data class DbClusterArgs(val allocatedStorage: Output<Int>? = null, val associatedRoles: Output<List<DbClusterDbClusterRoleArgs>>? = null, val autoMinorVersionUpgrade: Output<Boolean>? = null, val availabilityZones: Output<List<String>>? = null, val backtrackWindow: Output<Int>? = null, val backupRetentionPeriod: Output<Int>? = null, val copyTagsToSnapshot: Output<Boolean>? = null, val databaseName: Output<String>? = null, val dbClusterIdentifier: Output<String>? = null, val dbClusterInstanceClass: Output<String>? = null, val dbClusterParameterGroupName: Output<String>? = null, val dbInstanceParameterGroupName: Output<String>? = null, val dbSubnetGroupName: Output<String>? = null, val dbSystemId: Output<String>? = null, val deletionProtection: Output<Boolean>? = null, val domain: Output<String>? = null, val domainIamRoleName: Output<String>? = null, val enableCloudwatchLogsExports: Output<List<String>>? = null, val enableGlobalWriteForwarding: Output<Boolean>? = null, val enableHttpEndpoint: Output<Boolean>? = null, val enableIamDatabaseAuthentication: Output<Boolean>? = null, val enableLocalWriteForwarding: Output<Boolean>? = null, val engine: Output<String>? = null, val engineLifecycleSupport: Output<String>? = null, val engineMode: Output<String>? = null, val engineVersion: Output<String>? = null, val globalClusterIdentifier: Output<String>? = null, val iops: Output<Int>? = null, val kmsKeyId: Output<String>? = null, val manageMasterUserPassword: Output<Boolean>? = null, val masterUserPassword: Output<String>? = null, val masterUserSecret: Output<DbClusterMasterUserSecretArgs>? = null, val masterUsername: Output<String>? = null, val monitoringInterval: Output<Int>? = null, val monitoringRoleArn: Output<String>? = null, val networkType: Output<String>? = null, val performanceInsightsEnabled: Output<Boolean>? = null, val performanceInsightsKmsKeyId: Output<String>? = null, val performanceInsightsRetentionPeriod: Output<Int>? = null, val port: Output<Int>? = null, val preferredBackupWindow: Output<String>? = null, val preferredMaintenanceWindow: Output<String>? = null, val publiclyAccessible: Output<Boolean>? = null, val readEndpoint: Output<DbClusterReadEndpointArgs>? = null, val replicationSourceIdentifier: Output<String>? = null, val restoreToTime: Output<String>? = null, val restoreType: Output<String>? = null, val scalingConfiguration: Output<DbClusterScalingConfigurationArgs>? = null, val serverlessV2ScalingConfiguration: Output<DbClusterServerlessV2ScalingConfigurationArgs>? = null, val snapshotIdentifier: Output<String>? = null, val sourceDbClusterIdentifier: Output<String>? = null, val sourceRegion: Output<String>? = null, val storageEncrypted: Output<Boolean>? = null, val storageType: Output<String>? = null, val tags: Output<List<TagArgs>>? = null, val useLatestRestorableTime: Output<Boolean>? = null, val vpcSecurityGroupIds: Output<List<String>>? = null) : ConvertibleToJava<DbClusterArgs>

DbClusterArgsBuilder

class DbClusterArgsBuilder

Builder for DbClusterArgs.

DbClusterMapper

object DbClusterMapper : ResourceMapper<DbCluster>

DbClusterParameterGroup

class DbClusterParameterGroup : KotlinCustomResource

The `AWS::RDS::DBClusterParameterGroup` resource creates a new Amazon RDS DB cluster parameter group. For information about configuring parameters for Amazon Aurora DB clusters, see Working with parameter groups in the Amazon Aurora User Guide. If you apply a parameter group to a DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting. If you apply a change to parameter group associated with a stopped DB cluster, then the updated stack waits until the DB cluster is started.

DbClusterParameterGroupArgs

data class DbClusterParameterGroupArgs(val dbClusterParameterGroupName: Output<String>? = null, val description: Output<String>? = null, val family: Output<String>? = null, val parameters: Output<Any>? = null, val tags: Output<List<TagArgs>>? = null) : ConvertibleToJava<DbClusterParameterGroupArgs>

DbClusterParameterGroupArgsBuilder

class DbClusterParameterGroupArgsBuilder

Builder for DbClusterParameterGroupArgs.

DbClusterParameterGroupMapper

object DbClusterParameterGroupMapper : ResourceMapper<DbClusterParameterGroup>

DbClusterParameterGroupResourceBuilder

class DbClusterParameterGroupResourceBuilder

Builder for DbClusterParameterGroup.

DbClusterResourceBuilder

class DbClusterResourceBuilder

Builder for DbCluster.

DbInstance

class DbInstance : KotlinCustomResource

The `AWS::RDS::DBInstance` resource creates an Amazon DB instance. The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. For more information about creating an RDS DB instance, see Creating an Amazon RDS DB instance in the Amazon RDS User Guide. For more information about creating a DB instance in an Aurora DB cluster, see Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide. If you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation. If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced. For more information, see Prevent Updates to Stack Resources. Updating DB instances When properties labeled "Update requires: Replacement" are updated, AWS CloudFormation first creates a replacement DB instance, then changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance. We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB instance. To preserve your data, perform the following procedure:

DbInstanceArgs

data class DbInstanceArgs(val allocatedStorage: Output<String>? = null, val allowMajorVersionUpgrade: Output<Boolean>? = null, val associatedRoles: Output<List<DbInstanceDbInstanceRoleArgs>>? = null, val autoMinorVersionUpgrade: Output<Boolean>? = null, val automaticBackupReplicationKmsKeyId: Output<String>? = null, val automaticBackupReplicationRegion: Output<String>? = null, val availabilityZone: Output<String>? = null, val backupRetentionPeriod: Output<Int>? = null, val caCertificateIdentifier: Output<String>? = null, val certificateDetails: Output<DbInstanceCertificateDetailsArgs>? = null, val certificateRotationRestart: Output<Boolean>? = null, val characterSetName: Output<String>? = null, val copyTagsToSnapshot: Output<Boolean>? = null, val customIamInstanceProfile: Output<String>? = null, val dbClusterIdentifier: Output<String>? = null, val dbClusterSnapshotIdentifier: Output<String>? = null, val dbInstanceClass: Output<String>? = null, val dbInstanceIdentifier: Output<String>? = null, val dbName: Output<String>? = null, val dbParameterGroupName: Output<String>? = null, val dbSecurityGroups: Output<List<String>>? = null, val dbSnapshotIdentifier: Output<String>? = null, val dbSubnetGroupName: Output<String>? = null, val dedicatedLogVolume: Output<Boolean>? = null, val deleteAutomatedBackups: Output<Boolean>? = null, val deletionProtection: Output<Boolean>? = null, val domain: Output<String>? = null, val domainAuthSecretArn: Output<String>? = null, val domainDnsIps: Output<List<String>>? = null, val domainFqdn: Output<String>? = null, val domainIamRoleName: Output<String>? = null, val domainOu: Output<String>? = null, val enableCloudwatchLogsExports: Output<List<String>>? = null, val enableIamDatabaseAuthentication: Output<Boolean>? = null, val enablePerformanceInsights: Output<Boolean>? = null, val endpoint: Output<DbInstanceEndpointArgs>? = null, val engine: Output<String>? = null, val engineLifecycleSupport: Output<String>? = null, val engineVersion: Output<String>? = null, val iops: Output<Int>? = null, val kmsKeyId: Output<String>? = null, val licenseModel: Output<String>? = null, val manageMasterUserPassword: Output<Boolean>? = null, val masterUserPassword: Output<String>? = null, val masterUserSecret: Output<DbInstanceMasterUserSecretArgs>? = null, val masterUsername: Output<String>? = null, val maxAllocatedStorage: Output<Int>? = null, val monitoringInterval: Output<Int>? = null, val monitoringRoleArn: Output<String>? = null, val multiAz: Output<Boolean>? = null, val ncharCharacterSetName: Output<String>? = null, val networkType: Output<String>? = null, val optionGroupName: Output<String>? = null, val performanceInsightsKmsKeyId: Output<String>? = null, val performanceInsightsRetentionPeriod: Output<Int>? = null, val port: Output<String>? = null, val preferredBackupWindow: Output<String>? = null, val preferredMaintenanceWindow: Output<String>? = null, val processorFeatures: Output<List<DbInstanceProcessorFeatureArgs>>? = null, val promotionTier: Output<Int>? = null, val publiclyAccessible: Output<Boolean>? = null, val replicaMode: Output<String>? = null, val restoreTime: Output<String>? = null, val sourceDbClusterIdentifier: Output<String>? = null, val sourceDbInstanceAutomatedBackupsArn: Output<String>? = null, val sourceDbInstanceIdentifier: Output<String>? = null, val sourceDbiResourceId: Output<String>? = null, val sourceRegion: Output<String>? = null, val storageEncrypted: Output<Boolean>? = null, val storageThroughput: Output<Int>? = null, val storageType: Output<String>? = null, val tags: Output<List<TagArgs>>? = null, val tdeCredentialArn: Output<String>? = null, val tdeCredentialPassword: Output<String>? = null, val timezone: Output<String>? = null, val useDefaultProcessorFeatures: Output<Boolean>? = null, val useLatestRestorableTime: Output<Boolean>? = null, val vpcSecurityGroups: Output<List<String>>? = null) : ConvertibleToJava<DbInstanceArgs>

DbInstanceArgsBuilder

class DbInstanceArgsBuilder

Builder for DbInstanceArgs.

DbInstanceMapper

object DbInstanceMapper : ResourceMapper<DbInstance>

DbInstanceResourceBuilder

class DbInstanceResourceBuilder

Builder for DbInstance.

DbParameterGroup

class DbParameterGroup : KotlinCustomResource

The `AWS::RDS::DBParameterGroup` resource creates a custom parameter group for an RDS database family. This type can be declared in a template and referenced in the `DBParameterGroupName` property of an `AWS::RDS::DBInstance` resource. For information about configuring parameters for Amazon RDS DB instances, see Working with parameter groups in the Amazon RDS User Guide. For information about configuring parameters for Amazon Aurora DB instances, see Working with parameter groups in the Amazon Aurora User Guide. Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.

DbParameterGroupArgs

data class DbParameterGroupArgs(val dbParameterGroupName: Output<String>? = null, val description: Output<String>? = null, val family: Output<String>? = null, val parameters: Output<Any>? = null, val tags: Output<List<TagArgs>>? = null) : ConvertibleToJava<DbParameterGroupArgs>

DbParameterGroupArgsBuilder

class DbParameterGroupArgsBuilder

Builder for DbParameterGroupArgs.

DbParameterGroupMapper

object DbParameterGroupMapper : ResourceMapper<DbParameterGroup>

DbParameterGroupResourceBuilder

class DbParameterGroupResourceBuilder

Builder for DbParameterGroup.

DbProxy

class DbProxy : KotlinCustomResource

Resource schema for AWS::RDS::DBProxy

DbProxyArgs

data class DbProxyArgs(val auth: Output<List<DbProxyAuthFormatArgs>>? = null, val dbProxyName: Output<String>? = null, val debugLogging: Output<Boolean>? = null, val engineFamily: Output<DbProxyEngineFamily>? = null, val idleClientTimeout: Output<Int>? = null, val requireTls: Output<Boolean>? = null, val roleArn: Output<String>? = null, val tags: Output<List<TagArgs>>? = null, val vpcSecurityGroupIds: Output<List<String>>? = null, val vpcSubnetIds: Output<List<String>>? = null) : ConvertibleToJava<DbProxyArgs>

Resource schema for AWS::RDS::DBProxy

DbProxyArgsBuilder

class DbProxyArgsBuilder

Builder for DbProxyArgs.

DbProxyEndpoint

class DbProxyEndpoint : KotlinCustomResource

Resource schema for AWS::RDS::DBProxyEndpoint.

DbProxyEndpointArgs

data class DbProxyEndpointArgs(val dbProxyEndpointName: Output<String>? = null, val dbProxyName: Output<String>? = null, val tags: Output<List<TagArgs>>? = null, val targetRole: Output<DbProxyEndpointTargetRole>? = null, val vpcSecurityGroupIds: Output<List<String>>? = null, val vpcSubnetIds: Output<List<String>>? = null) : ConvertibleToJava<DbProxyEndpointArgs>

Resource schema for AWS::RDS::DBProxyEndpoint.

DbProxyEndpointArgsBuilder

class DbProxyEndpointArgsBuilder

Builder for DbProxyEndpointArgs.

DbProxyEndpointMapper

object DbProxyEndpointMapper : ResourceMapper<DbProxyEndpoint>

DbProxyEndpointResourceBuilder

class DbProxyEndpointResourceBuilder

Builder for DbProxyEndpoint.

DbProxyMapper

object DbProxyMapper : ResourceMapper<DbProxy>

DbProxyResourceBuilder

class DbProxyResourceBuilder

Builder for DbProxy.

DbProxyTargetGroup

class DbProxyTargetGroup : KotlinCustomResource

Resource schema for AWS::RDS::DBProxyTargetGroup

DbProxyTargetGroupArgs

data class DbProxyTargetGroupArgs(val connectionPoolConfigurationInfo: Output<DbProxyTargetGroupConnectionPoolConfigurationInfoFormatArgs>? = null, val dbClusterIdentifiers: Output<List<String>>? = null, val dbInstanceIdentifiers: Output<List<String>>? = null, val dbProxyName: Output<String>? = null, val targetGroupName: Output<DbProxyTargetGroupTargetGroupName>? = null) : ConvertibleToJava<DbProxyTargetGroupArgs>

Resource schema for AWS::RDS::DBProxyTargetGroup

DbProxyTargetGroupArgsBuilder

class DbProxyTargetGroupArgsBuilder

Builder for DbProxyTargetGroupArgs.

DbProxyTargetGroupMapper

object DbProxyTargetGroupMapper : ResourceMapper<DbProxyTargetGroup>

DbProxyTargetGroupResourceBuilder

class DbProxyTargetGroupResourceBuilder

Builder for DbProxyTargetGroup.

DbSubnetGroup

class DbSubnetGroup : KotlinCustomResource

The `AWS::RDS::DBSubnetGroup` resource creates a database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region. For more information, see Working with DB subnet groups in the Amazon RDS User Guide.

DbSubnetGroupArgs

data class DbSubnetGroupArgs(val dbSubnetGroupDescription: Output<String>? = null, val dbSubnetGroupName: Output<String>? = null, val subnetIds: Output<List<String>>? = null, val tags: Output<List<TagArgs>>? = null) : ConvertibleToJava<DbSubnetGroupArgs>

DbSubnetGroupArgsBuilder

class DbSubnetGroupArgsBuilder

Builder for DbSubnetGroupArgs.

DbSubnetGroupMapper

object DbSubnetGroupMapper : ResourceMapper<DbSubnetGroup>

DbSubnetGroupResourceBuilder

class DbSubnetGroupResourceBuilder

Builder for DbSubnetGroup.

EventSubscription

class EventSubscription : KotlinCustomResource

The `AWS::RDS::EventSubscription` resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS). For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide.

EventSubscriptionArgs

data class EventSubscriptionArgs(val enabled: Output<Boolean>? = null, val eventCategories: Output<List<String>>? = null, val snsTopicArn: Output<String>? = null, val sourceIds: Output<List<String>>? = null, val sourceType: Output<String>? = null, val subscriptionName: Output<String>? = null, val tags: Output<List<TagArgs>>? = null) : ConvertibleToJava<EventSubscriptionArgs>

EventSubscriptionArgsBuilder

class EventSubscriptionArgsBuilder

Builder for EventSubscriptionArgs.

EventSubscriptionMapper

object EventSubscriptionMapper : ResourceMapper<EventSubscription>

EventSubscriptionResourceBuilder

class EventSubscriptionResourceBuilder

Builder for EventSubscription.

GlobalCluster

class GlobalCluster : KotlinCustomResource

Resource Type definition for AWS::RDS::GlobalCluster

GlobalClusterArgs

data class GlobalClusterArgs(val deletionProtection: Output<Boolean>? = null, val engine: Output<GlobalClusterEngine>? = null, val engineLifecycleSupport: Output<String>? = null, val engineVersion: Output<String>? = null, val globalClusterIdentifier: Output<String>? = null, val sourceDbClusterIdentifier: Output<String>? = null, val storageEncrypted: Output<Boolean>? = null, val tags: Output<List<TagArgs>>? = null) : ConvertibleToJava<GlobalClusterArgs>

Resource Type definition for AWS::RDS::GlobalCluster

GlobalClusterArgsBuilder

class GlobalClusterArgsBuilder

Builder for GlobalClusterArgs.

GlobalClusterMapper

object GlobalClusterMapper : ResourceMapper<GlobalCluster>

GlobalClusterResourceBuilder

class GlobalClusterResourceBuilder

Builder for GlobalCluster.

Integration

class Integration : KotlinCustomResource

A zero-ETL integration with Amazon Redshift.

IntegrationArgs

data class IntegrationArgs(val additionalEncryptionContext: Output<Map<String, String>>? = null, val dataFilter: Output<String>? = null, val description: Output<String>? = null, val integrationName: Output<String>? = null, val kmsKeyId: Output<String>? = null, val sourceArn: Output<String>? = null, val tags: Output<List<TagArgs>>? = null, val targetArn: Output<String>? = null) : ConvertibleToJava<IntegrationArgs>

A zero-ETL integration with Amazon Redshift.

IntegrationArgsBuilder

class IntegrationArgsBuilder

Builder for IntegrationArgs.

IntegrationMapper

object IntegrationMapper : ResourceMapper<Integration>

IntegrationResourceBuilder

class IntegrationResourceBuilder

Builder for Integration.

OptionGroup

class OptionGroup : KotlinCustomResource

The `AWS::RDS::OptionGroup` resource creates or updates an option group, to enable and configure features that are specific to a particular DB engine.

OptionGroupArgs

data class OptionGroupArgs(val engineName: Output<String>? = null, val majorEngineVersion: Output<String>? = null, val optionConfigurations: Output<List<OptionGroupOptionConfigurationArgs>>? = null, val optionGroupDescription: Output<String>? = null, val optionGroupName: Output<String>? = null, val tags: Output<List<TagArgs>>? = null) : ConvertibleToJava<OptionGroupArgs>

The `AWS::RDS::OptionGroup` resource creates or updates an option group, to enable and configure features that are specific to a particular DB engine.

OptionGroupArgsBuilder

class OptionGroupArgsBuilder

Builder for OptionGroupArgs.

OptionGroupMapper

object OptionGroupMapper : ResourceMapper<OptionGroup>

OptionGroupResourceBuilder

class OptionGroupResourceBuilder

Builder for OptionGroup.

RdsFunctions

object RdsFunctions