The fully qualified domain name of the Active Directory Domain.
+ *The fully qualified domain name (FQDN) of the Active Directory Domain.
*/ FQDN?: string; @@ -4654,6 +4654,21 @@ export interface DomainMembership { *The name of the IAM role to be used when making API calls to the Directory Service.
*/ IAMRoleName?: string; + + /** + *The Active Directory organizational unit for your DB instance to join.
+ */ + OU?: string; + + /** + *The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
+ */ + AuthSecretArn?: string; + + /** + *The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
+ */ + DnsIps?: string[]; } /** @@ -6861,6 +6876,55 @@ export interface CreateDBInstanceMessage { */ Domain?: string; + /** + *Specifies the fully qualified domain name of an Active Directory domain.
+ *Constraints:
+ *Cannot be greater than 64 characters.
+ *Example: mymanagedADtest.mymanagedAD.mydomain
+ *
The Active Directory organizational unit for your DB instance to join.
+ *Constraints:
+ *Must be in the distinguished name format.
+ *Cannot be greater than 64 characters.
+ *Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
+ *
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
+ *Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
+ *
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
+ *Constraints:
+ *Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
+ *Example: 123.124.125.126,234.235.236.237
+ *
Spcifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
*This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this @@ -8759,6 +8823,55 @@ export interface CreateDBInstanceReadReplicaMessage { */ DomainIAMRoleName?: string; + /** + *
Specifies the fully qualified domain name of an Active Directory domain.
+ *Constraints:
+ *Cannot be greater than 64 characters.
+ *Example: mymanagedADtest.mymanagedAD.mydomain
+ *
The Active Directory organizational unit for your DB instance to join.
+ *Constraints:
+ *Must be in the distinguished name format.
+ *Cannot be greater than 64 characters.
+ *Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
+ *
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
+ *Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
+ *
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
+ *Constraints:
+ *Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
+ *Example: 123.124.125.126,234.235.236.237
+ *
The open mode of the replica database: mounted or read-only.
*Specifies the fully qualified domain name of an Active Directory domain.
+ *Constraints:
+ *Cannot be greater than 64 characters.
+ *Example: mymanagedADtest.mymanagedAD.mydomain
+ *
The Active Directory organizational unit for your DB instance to join.
+ *Constraints:
+ *Must be in the distinguished name format.
+ *Cannot be greater than 64 characters.
+ *Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
+ *
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
+ *Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
+ *
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
+ *Constraints:
+ *Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
+ *Example: 123.124.125.126,234.235.236.237
+ *
Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags aren't copied.
*This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this @@ -5053,6 +5102,11 @@ export interface ModifyDBInstanceMessage { */ DomainIAMRoleName?: string; + /** + *
Boolean. If present, removes the instance from the Active Directory domain.
+ */ + DisableDomain?: boolean; + /** *The order of priority in which an Aurora Replica is promoted to the primary instance * after a failure of the existing primary instance. For more information, @@ -8128,6 +8182,56 @@ export interface RestoreDBInstanceFromDBSnapshotMessage { */ Domain?: string; + /** + *
Specifies the fully qualified domain name of an Active Directory domain.
+ *Constraints:
+ *Cannot be greater than 64 characters.
+ *Example: mymanagedADtest.mymanagedAD.mydomain
+ *
The Active Directory organizational unit for your DB instance to join.
+ *Constraints:
+ *Must be in the distinguished name format.
+ *Cannot be greater than 64 characters.
+ *Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
+ *
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
+ *Constraints:
+ *Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
+ *
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
+ *Constraints:
+ *Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
+ *Example: 123.124.125.126,234.235.236.237
+ *
A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.
*In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you @@ -9173,6 +9277,61 @@ export interface RestoreDBInstanceToPointInTimeMessage { */ DomainIAMRoleName?: string; + /** + *
Specifies the fully qualified domain name of an Active Directory domain.
+ *Constraints:
+ *Cannot be greater than 64 characters.
+ *Example: mymanagedADtest.mymanagedAD.mydomain
+ *
The Active Directory organizational unit for your DB instance to join.
+ *Constraints:
+ *Must be in the distinguished name format.
+ *Cannot be greater than 64 characters.
+ *Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
+ *
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
+ *Constraints:
+ *Cannot be greater than 64 characters.
+ *Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
+ *
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
+ *Constraints:
+ *Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
+ *Example: 123.124.125.126,234.235.236.237
+ *
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management * (IAM) accounts to database accounts. By default, mapping isn't enabled.
diff --git a/clients/client-rds/src/protocols/Aws_query.ts b/clients/client-rds/src/protocols/Aws_query.ts index e79e485ae1285..345df98269be7 100644 --- a/clients/client-rds/src/protocols/Aws_query.ts +++ b/clients/client-rds/src/protocols/Aws_query.ts @@ -13988,6 +13988,25 @@ const se_CreateDBInstanceMessage = (input: CreateDBInstanceMessage, context: __S if (input.Domain != null) { entries["Domain"] = input.Domain; } + if (input.DomainFqdn != null) { + entries["DomainFqdn"] = input.DomainFqdn; + } + if (input.DomainOu != null) { + entries["DomainOu"] = input.DomainOu; + } + if (input.DomainAuthSecretArn != null) { + entries["DomainAuthSecretArn"] = input.DomainAuthSecretArn; + } + if (input.DomainDnsIps != null) { + const memberEntries = se_StringList(input.DomainDnsIps, context); + if (input.DomainDnsIps?.length === 0) { + entries.DomainDnsIps = []; + } + Object.entries(memberEntries).forEach(([key, value]) => { + const loc = `DomainDnsIps.${key}`; + entries[loc] = value; + }); + } if (input.CopyTagsToSnapshot != null) { entries["CopyTagsToSnapshot"] = input.CopyTagsToSnapshot; } @@ -14197,6 +14216,25 @@ const se_CreateDBInstanceReadReplicaMessage = ( if (input.DomainIAMRoleName != null) { entries["DomainIAMRoleName"] = input.DomainIAMRoleName; } + if (input.DomainFqdn != null) { + entries["DomainFqdn"] = input.DomainFqdn; + } + if (input.DomainOu != null) { + entries["DomainOu"] = input.DomainOu; + } + if (input.DomainAuthSecretArn != null) { + entries["DomainAuthSecretArn"] = input.DomainAuthSecretArn; + } + if (input.DomainDnsIps != null) { + const memberEntries = se_StringList(input.DomainDnsIps, context); + if (input.DomainDnsIps?.length === 0) { + entries.DomainDnsIps = []; + } + Object.entries(memberEntries).forEach(([key, value]) => { + const loc = `DomainDnsIps.${key}`; + entries[loc] = value; + }); + } if (input.ReplicaMode != null) { entries["ReplicaMode"] = input.ReplicaMode; } @@ -16636,6 +16674,25 @@ const se_ModifyDBInstanceMessage = (input: ModifyDBInstanceMessage, context: __S if (input.Domain != null) { entries["Domain"] = input.Domain; } + if (input.DomainFqdn != null) { + entries["DomainFqdn"] = input.DomainFqdn; + } + if (input.DomainOu != null) { + entries["DomainOu"] = input.DomainOu; + } + if (input.DomainAuthSecretArn != null) { + entries["DomainAuthSecretArn"] = input.DomainAuthSecretArn; + } + if (input.DomainDnsIps != null) { + const memberEntries = se_StringList(input.DomainDnsIps, context); + if (input.DomainDnsIps?.length === 0) { + entries.DomainDnsIps = []; + } + Object.entries(memberEntries).forEach(([key, value]) => { + const loc = `DomainDnsIps.${key}`; + entries[loc] = value; + }); + } if (input.CopyTagsToSnapshot != null) { entries["CopyTagsToSnapshot"] = input.CopyTagsToSnapshot; } @@ -16654,6 +16711,9 @@ const se_ModifyDBInstanceMessage = (input: ModifyDBInstanceMessage, context: __S if (input.DomainIAMRoleName != null) { entries["DomainIAMRoleName"] = input.DomainIAMRoleName; } + if (input.DisableDomain != null) { + entries["DisableDomain"] = input.DisableDomain; + } if (input.PromotionTier != null) { entries["PromotionTier"] = input.PromotionTier; } @@ -17986,6 +18046,25 @@ const se_RestoreDBInstanceFromDBSnapshotMessage = ( if (input.Domain != null) { entries["Domain"] = input.Domain; } + if (input.DomainFqdn != null) { + entries["DomainFqdn"] = input.DomainFqdn; + } + if (input.DomainOu != null) { + entries["DomainOu"] = input.DomainOu; + } + if (input.DomainAuthSecretArn != null) { + entries["DomainAuthSecretArn"] = input.DomainAuthSecretArn; + } + if (input.DomainDnsIps != null) { + const memberEntries = se_StringList(input.DomainDnsIps, context); + if (input.DomainDnsIps?.length === 0) { + entries.DomainDnsIps = []; + } + Object.entries(memberEntries).forEach(([key, value]) => { + const loc = `DomainDnsIps.${key}`; + entries[loc] = value; + }); + } if (input.CopyTagsToSnapshot != null) { entries["CopyTagsToSnapshot"] = input.CopyTagsToSnapshot; } @@ -18329,6 +18408,25 @@ const se_RestoreDBInstanceToPointInTimeMessage = ( if (input.DomainIAMRoleName != null) { entries["DomainIAMRoleName"] = input.DomainIAMRoleName; } + if (input.DomainFqdn != null) { + entries["DomainFqdn"] = input.DomainFqdn; + } + if (input.DomainOu != null) { + entries["DomainOu"] = input.DomainOu; + } + if (input.DomainAuthSecretArn != null) { + entries["DomainAuthSecretArn"] = input.DomainAuthSecretArn; + } + if (input.DomainDnsIps != null) { + const memberEntries = se_StringList(input.DomainDnsIps, context); + if (input.DomainDnsIps?.length === 0) { + entries.DomainDnsIps = []; + } + Object.entries(memberEntries).forEach(([key, value]) => { + const loc = `DomainDnsIps.${key}`; + entries[loc] = value; + }); + } if (input.EnableIAMDatabaseAuthentication != null) { entries["EnableIAMDatabaseAuthentication"] = input.EnableIAMDatabaseAuthentication; } @@ -22797,6 +22895,17 @@ const de_DomainMembership = (output: any, context: __SerdeContext): DomainMember if (output["IAMRoleName"] !== undefined) { contents.IAMRoleName = __expectString(output["IAMRoleName"]); } + if (output["OU"] !== undefined) { + contents.OU = __expectString(output["OU"]); + } + if (output["AuthSecretArn"] !== undefined) { + contents.AuthSecretArn = __expectString(output["AuthSecretArn"]); + } + if (output.DnsIps === "") { + contents.DnsIps = []; + } else if (output["DnsIps"] !== undefined && output["DnsIps"]["member"] !== undefined) { + contents.DnsIps = de_StringList(__getArrayIfSingleItem(output["DnsIps"]["member"]), context); + } return contents; }; diff --git a/codegen/sdk-codegen/aws-models/rds.json b/codegen/sdk-codegen/aws-models/rds.json index 51eb8b4971ceb..1bad9971e3097 100644 --- a/codegen/sdk-codegen/aws-models/rds.json +++ b/codegen/sdk-codegen/aws-models/rds.json @@ -4314,6 +4314,30 @@ "smithy.api#documentation": "The Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL \n Server, MySQL, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nThis setting doesn't apply to the following DB instances:
\nAmazon Aurora (The domain is managed by the DB cluster.)
\nRDS Custom
\nSpecifies the fully qualified domain name of an Active Directory domain.
\nConstraints:
\nCannot be greater than 64 characters.
\nExample: mymanagedADtest.mymanagedAD.mydomain\n
The Active Directory organizational unit for your DB instance to join.
\nConstraints:
\nMust be in the distinguished name format.
\nCannot be greater than 64 characters.
\nExample: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain\n
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
\nExample: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
\nConstraints:
\nTwo IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
\nExample: 123.124.125.126,234.235.236.237\n
The name of the IAM role to be used when making API calls to the Directory\n Service.
\nThis setting doesn't apply to RDS Custom.
" } }, + "DomainFqdn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "Specifies the fully qualified domain name of an Active Directory domain.
\nConstraints:
\nCannot be greater than 64 characters.
\nExample: mymanagedADtest.mymanagedAD.mydomain\n
The Active Directory organizational unit for your DB instance to join.
\nConstraints:
\nMust be in the distinguished name format.
\nCannot be greater than 64 characters.
\nExample: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain\n
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
\nExample: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
\nConstraints:
\nTwo IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
\nExample: 123.124.125.126,234.235.236.237\n
The fully qualified domain name of the Active Directory Domain.
" + "smithy.api#documentation": "The fully qualified domain name (FQDN) of the Active Directory Domain.
" } }, "IAMRoleName": { @@ -13590,6 +13638,24 @@ "traits": { "smithy.api#documentation": "The name of the IAM role to be used when making API calls to the Directory Service.
" } + }, + "OU": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The Active Directory organizational unit for your DB instance to join.
" + } + }, + "AuthSecretArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
" + } + }, + "DnsIps": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
" + } } }, "traits": { @@ -16468,6 +16534,30 @@ "smithy.api#documentation": "The Active Directory directory ID to move the DB instance to. \n Specify none to remove the instance from its current domain.\n You must create the domain before this operation. Currently, you can create only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, + "DomainFqdn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "Specifies the fully qualified domain name of an Active Directory domain.
\nConstraints:
\nCannot be greater than 64 characters.
\nExample: mymanagedADtest.mymanagedAD.mydomain\n
The Active Directory organizational unit for your DB instance to join.
\nConstraints:
\nMust be in the distinguished name format.
\nCannot be greater than 64 characters.
\nExample: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain\n
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
\nExample: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
\nConstraints:
\nTwo IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
\nExample: 123.124.125.126,234.235.236.237\n
The name of the IAM role to use when making API calls to the Directory Service.
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, + "DisableDomain": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "Boolean. If present, removes the instance from the Active Directory domain.
" + } + }, "PromotionTier": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { @@ -20815,6 +20911,30 @@ "smithy.api#documentation": "Specify the Active Directory directory ID to restore the DB instance in.\n The domain/ must be created prior to this operation. Currently, you can create only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" } }, + "DomainFqdn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "Specifies the fully qualified domain name of an Active Directory domain.
\nConstraints:
\nCannot be greater than 64 characters.
\nExample: mymanagedADtest.mymanagedAD.mydomain\n
The Active Directory organizational unit for your DB instance to join.
\nConstraints:
\nMust be in the distinguished name format.
\nCannot be greater than 64 characters.
\nExample: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain\n
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
\nConstraints:
\nExample: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
\nConstraints:
\nTwo IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
\nExample: 123.124.125.126,234.235.236.237\n
Specify the name of the IAM role to be used when making API calls to the Directory Service.
\nThis setting doesn't apply to RDS Custom.
" } }, + "DomainFqdn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "Specifies the fully qualified domain name of an Active Directory domain.
\nConstraints:
\nCannot be greater than 64 characters.
\nExample: mymanagedADtest.mymanagedAD.mydomain\n
The Active Directory organizational unit for your DB instance to join.
\nConstraints:
\nMust be in the distinguished name format.
\nCannot be greater than 64 characters.
\nExample: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain\n
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
\nConstraints:
\nCannot be greater than 64 characters.
\nExample: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
\nConstraints:
\nTwo IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
\nExample: 123.124.125.126,234.235.236.237\n