modules/AWSPowerShell/Cmdlets/RDS/Basic/Restore-RDSDBClusterFromS3-Cmdlet.cs

/******************************************************************************* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * Licensed under the Apache License, Version 2.0 (the "License"). You may not use * this file except in compliance with the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. * This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the * specific language governing permissions and limitations under the License. * ***************************************************************************** * * AWS Tools for Windows (TM) PowerShell (TM) * */ using System; using System.Collections.Generic; using System.Linq; using System.Management.Automation; using System.Text; using Amazon.PowerShell.Common; using Amazon.Runtime; using Amazon.RDS; using Amazon.RDS.Model; namespace Amazon.PowerShell.Cmdlets.RDS { /// <summary> /// Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. /// Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be /// created using the Percona XtraBackup utility as described in <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Migrating.ExtMySQL.html#AuroraMySQL.Migrating.ExtMySQL.S3"> /// Migrating Data from MySQL by Using an Amazon S3 Bucket</a> in the Amazon Aurora /// User Guide. /// /// <note><para> /// This operation only restores the DB cluster, not the DB instances for that DB cluster. /// You must invoke the <c>CreateDBInstance</c> operation to create DB instances for the /// restored DB cluster, specifying the identifier of the restored DB cluster in <c>DBClusterIdentifier</c>. /// You can create DB instances only after the <c>RestoreDBClusterFromS3</c> operation /// has completed and the DB cluster is available. /// </para></note><para> /// For more information on Amazon Aurora, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html"> /// What is Amazon Aurora?</a> in the Amazon Aurora User Guide. /// </para><note><para> /// This operation only applies to Aurora DB clusters. The source DB engine must be MySQL. /// </para></note> /// </summary> [Cmdlet("Restore", "RDSDBClusterFromS3", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.RDS.Model.DBCluster")] [AWSCmdlet("Calls the Amazon Relational Database Service RestoreDBClusterFromS3 API operation.", Operation = new[] {"RestoreDBClusterFromS3"}, SelectReturnType = typeof(Amazon.RDS.Model.RestoreDBClusterFromS3Response))] [AWSCmdletOutput("Amazon.RDS.Model.DBCluster or Amazon.RDS.Model.RestoreDBClusterFromS3Response", "This cmdlet returns an Amazon.RDS.Model.DBCluster object.", "The service call response (type Amazon.RDS.Model.RestoreDBClusterFromS3Response) can be returned by specifying '-Select *'." )] public partial class RestoreRDSDBClusterFromS3Cmdlet : AmazonRDSClientCmdlet, IExecutor { protected override bool IsGeneratedCmdlet { get; set; } = true; #region Parameter AvailabilityZone /// <summary> /// <para> /// <para>A list of Availability Zones (AZs) where instances in the restored DB cluster can /// be created.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("AvailabilityZones")] public System.String[] AvailabilityZone { get; set; } #endregion #region Parameter BacktrackWindow /// <summary> /// <para> /// <para>The target backtrack window, in seconds. To disable backtracking, set this value to /// 0.</para><note><para>Currently, Backtrack is only supported for Aurora MySQL DB clusters.</para></note><para>Default: 0</para><para>Constraints:</para><ul><li><para>If specified, this value must be set to a number from 0 to 259,200 (72 hours).</para></li></ul> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int64? BacktrackWindow { get; set; } #endregion #region Parameter BackupRetentionPeriod /// <summary> /// <para> /// <para>The number of days for which automated backups of the restored DB cluster are retained. /// You must specify a minimum value of 1.</para><para>Default: 1</para><para>Constraints:</para><ul><li><para>Must be a value from 1 to 35</para></li></ul> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? BackupRetentionPeriod { get; set; } #endregion #region Parameter CharacterSetName /// <summary> /// <para> /// <para>A value that indicates that the restored DB cluster should be associated with the /// specified CharacterSet.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String CharacterSetName { get; set; } #endregion #region Parameter CopyTagsToSnapshot /// <summary> /// <para> /// <para>Specifies whether to copy all tags from the restored DB cluster to snapshots of the /// restored DB cluster. The default is not to copy them.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? CopyTagsToSnapshot { get; set; } #endregion #region Parameter DatabaseName /// <summary> /// <para> /// <para>The database name for the restored DB cluster.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String DatabaseName { get; set; } #endregion #region Parameter DBClusterIdentifier /// <summary> /// <para> /// <para>The name of the DB cluster to create from the source data in the Amazon S3 bucket. /// This parameter isn't case-sensitive.</para><para>Constraints:</para><ul><li><para>Must contain from 1 to 63 letters, numbers, or hyphens.</para></li><li><para>First character must be a letter.</para></li><li><para>Can't end with a hyphen or contain two consecutive hyphens.</para></li></ul><para>Example: <c>my-cluster1</c></para> /// </para> /// </summary> #if !MODULAR [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] #else [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String DBClusterIdentifier { get; set; } #endregion #region Parameter DBClusterParameterGroupName /// <summary> /// <para> /// <para>The name of the DB cluster parameter group to associate with the restored DB cluster. /// If this argument is omitted, the default parameter group for the engine version is /// used.</para><para>Constraints:</para><ul><li><para>If supplied, must match the name of an existing DBClusterParameterGroup.</para></li></ul> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String DBClusterParameterGroupName { get; set; } #endregion #region Parameter DBSubnetGroupName /// <summary> /// <para> /// <para>A DB subnet group to associate with the restored DB cluster.</para><para>Constraints: If supplied, must match the name of an existing DBSubnetGroup.</para><para>Example: <c>mydbsubnetgroup</c></para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String DBSubnetGroupName { get; set; } #endregion #region Parameter DeletionProtection /// <summary> /// <para> /// <para>Specifies whether to enable deletion protection for the DB cluster. The database can't /// be deleted when deletion protection is enabled. By default, deletion protection isn't /// enabled.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? DeletionProtection { get; set; } #endregion #region Parameter Domain /// <summary> /// <para> /// <para>Specify the Active Directory directory ID to restore the DB cluster in. The domain /// must be created prior to this operation.</para><para>For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate /// users that connect to the DB cluster. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html">Kerberos /// Authentication</a> in the Amazon Aurora User Guide.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Domain { get; set; } #endregion #region Parameter DomainIAMRoleName /// <summary> /// <para> /// <para>Specify the name of the IAM role to be used when making API calls to the Directory /// Service.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String DomainIAMRoleName { get; set; } #endregion #region Parameter EnableCloudwatchLogsExport /// <summary> /// <para> /// <para>The list of logs that the restored DB cluster is to export to CloudWatch Logs. The /// values in the list depend on the DB engine being used.</para><para>Aurora MySQL</para><para>Possible values are <c>audit</c>, <c>error</c>, <c>general</c>, <c>instance</c>, <c>slowquery</c>, /// and <c>iam-db-auth-error</c>.</para><para>Aurora PostgreSQL</para><para>Possible value are <c>instance</c>, <c>postgresql</c>, and <c>iam-db-auth-error</c>.</para><para>For more information about exporting CloudWatch Logs for Amazon RDS, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch">Publishing /// Database Logs to Amazon CloudWatch Logs</a> in the Amazon RDS User Guide.</para><para>For more information about exporting CloudWatch Logs for Amazon Aurora, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch">Publishing /// Database Logs to Amazon CloudWatch Logs</a> in the Amazon Aurora User Guide.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("EnableCloudwatchLogsExports")] public System.String[] EnableCloudwatchLogsExport { get; set; } #endregion #region Parameter EnableIAMDatabaseAuthentication /// <summary> /// <para> /// <para>Specifies whether to enable mapping of Amazon Web Services Identity and Access Management /// (IAM) accounts to database accounts. By default, mapping isn't enabled.</para><para>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html"> /// IAM Database Authentication</a> in the Amazon Aurora User Guide.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? EnableIAMDatabaseAuthentication { get; set; } #endregion #region Parameter Engine /// <summary> /// <para> /// <para>The name of the database engine to be used for this DB cluster.</para><para>Valid Values: <c>aurora-mysql</c> (for Aurora MySQL)</para> /// </para> /// </summary> #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String Engine { get; set; } #endregion #region Parameter EngineLifecycleSupport /// <summary> /// <para> /// <para>The life cycle type for this DB cluster.</para><note><para>By default, this value is set to <c>open-source-rds-extended-support</c>, which enrolls /// your DB cluster into Amazon RDS Extended Support. At the end of standard support, /// you can avoid charges for Extended Support by setting the value to <c>open-source-rds-extended-support-disabled</c>. /// In this case, RDS automatically upgrades your restored DB cluster to a higher engine /// version, if the major engine version is past its end of standard support date.</para></note><para>You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. /// With RDS Extended Support, you can run the selected major engine version on your DB /// cluster past the end of standard support for that engine version. For more information, /// see the following sections:</para><ul><li><para>Amazon Aurora - <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html">Using /// Amazon RDS Extended Support</a> in the Amazon Aurora User Guide</para></li><li><para>Amazon RDS - <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html">Using /// Amazon RDS Extended Support</a> in the Amazon RDS User Guide</para></li></ul><para>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</para><para>Valid Values: <c>open-source-rds-extended-support | open-source-rds-extended-support-disabled</c></para><para>Default: <c>open-source-rds-extended-support</c></para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String EngineLifecycleSupport { get; set; } #endregion #region Parameter EngineVersion /// <summary> /// <para> /// <para>The version number of the database engine to use.</para><para>To list all of the available engine versions for <c>aurora-mysql</c> (Aurora MySQL), /// use the following command:</para><para><c>aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"</c></para><para>Aurora MySQL</para><para>Examples: <c>5.7.mysql_aurora.2.12.0</c>, <c>8.0.mysql_aurora.3.04.0</c></para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String EngineVersion { get; set; } #endregion #region Parameter KmsKeyId /// <summary> /// <para> /// <para>The Amazon Web Services KMS key identifier for an encrypted DB cluster.</para><para>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias /// name for the KMS key. To use a KMS key in a different Amazon Web Services account, /// specify the key ARN or alias ARN.</para><para>If the StorageEncrypted parameter is enabled, and you do not specify a value for the /// <c>KmsKeyId</c> parameter, then Amazon RDS will use your default KMS key. There is /// a default KMS key for your Amazon Web Services account. Your Amazon Web Services account /// has a different default KMS key for each Amazon Web Services Region.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String KmsKeyId { get; set; } #endregion #region Parameter ManageMasterUserPassword /// <summary> /// <para> /// <para>Specifies whether to manage the master user password with Amazon Web Services Secrets /// Manager.</para><para>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html">Password /// management with Amazon Web Services Secrets Manager</a> in the Amazon RDS User /// Guide and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html">Password /// management with Amazon Web Services Secrets Manager</a> in the Amazon Aurora User /// Guide.</para><para>Constraints:</para><ul><li><para>Can't manage the master user password with Amazon Web Services Secrets Manager if /// <c>MasterUserPassword</c> is specified.</para></li></ul> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? ManageMasterUserPassword { get; set; } #endregion #region Parameter MasterUsername /// <summary> /// <para> /// <para>The name of the master user for the restored DB cluster.</para><para>Constraints:</para><ul><li><para>Must be 1 to 16 letters or numbers.</para></li><li><para>First character must be a letter.</para></li><li><para>Can't be a reserved word for the chosen database engine.</para></li></ul> /// </para> /// </summary> #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String MasterUsername { get; set; } #endregion #region Parameter MasterUserPassword /// <summary> /// <para> /// <para>The password for the master database user. This password can contain any printable /// ASCII character except "/", """, or "@".</para><para>Constraints:</para><ul><li><para>Must contain from 8 to 41 characters.</para></li><li><para>Can't be specified if <c>ManageMasterUserPassword</c> is turned on.</para></li></ul> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String MasterUserPassword { get; set; } #endregion #region Parameter MasterUserSecretKmsKeyId /// <summary> /// <para> /// <para>The Amazon Web Services KMS key identifier to encrypt a secret that is automatically /// generated and managed in Amazon Web Services Secrets Manager.</para><para>This setting is valid only if the master user password is managed by RDS in Amazon /// Web Services Secrets Manager for the DB cluster.</para><para>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias /// name for the KMS key. To use a KMS key in a different Amazon Web Services account, /// specify the key ARN or alias ARN.</para><para>If you don't specify <c>MasterUserSecretKmsKeyId</c>, then the <c>aws/secretsmanager</c> /// KMS key is used to encrypt the secret. If the secret is in a different Amazon Web /// Services account, then you can't use the <c>aws/secretsmanager</c> KMS key to encrypt /// the secret, and you must use a customer managed KMS key.</para><para>There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services /// account has a different default KMS key for each Amazon Web Services Region.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String MasterUserSecretKmsKeyId { get; set; } #endregion #region Parameter ServerlessV2ScalingConfiguration_MaxCapacity /// <summary> /// <para> /// <para>The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora /// Serverless v2 cluster. You can specify ACU values in half-step increments, such as /// 32, 32.5, 33, and so on. The largest value that you can use is 256 for recent Aurora /// versions, or 128 for older versions.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Double? ServerlessV2ScalingConfiguration_MaxCapacity { get; set; } #endregion #region Parameter ServerlessV2ScalingConfiguration_MinCapacity /// <summary> /// <para> /// <para>The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora /// Serverless v2 cluster. You can specify ACU values in half-step increments, such as /// 8, 8.5, 9, and so on. For Aurora versions that support the Aurora Serverless v2 auto-pause /// feature, the smallest value that you can use is 0. For versions that don't support /// Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5. </para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Double? ServerlessV2ScalingConfiguration_MinCapacity { get; set; } #endregion #region Parameter NetworkType /// <summary> /// <para> /// <para>The network type of the DB cluster.</para><para>Valid Values:</para><ul><li><para><c>IPV4</c></para></li><li><para><c>DUAL</c></para></li></ul><para>The network type is determined by the <c>DBSubnetGroup</c> specified for the DB cluster. /// A <c>DBSubnetGroup</c> can support only the IPv4 protocol or the IPv4 and the IPv6 /// protocols (<c>DUAL</c>).</para><para>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html"> /// Working with a DB instance in a VPC</a> in the Amazon Aurora User Guide.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String NetworkType { get; set; } #endregion #region Parameter OptionGroupName /// <summary> /// <para> /// <para>A value that indicates that the restored DB cluster should be associated with the /// specified option group.</para><para>Permanent options can't be removed from an option group. An option group can't be /// removed from a DB cluster once it is associated with a DB cluster.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String OptionGroupName { get; set; } #endregion #region Parameter Port /// <summary> /// <para> /// <para>The port number on which the instances in the restored DB cluster accept connections.</para><para>Default: <c>3306</c></para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? Port { get; set; } #endregion #region Parameter PreferredBackupWindow /// <summary> /// <para> /// <para>The daily time range during which automated backups are created if automated backups /// are enabled using the <c>BackupRetentionPeriod</c> parameter.</para><para>The default is a 30-minute window selected at random from an 8-hour block of time /// for each Amazon Web Services Region. To view the time blocks available, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow"> /// Backup window</a> in the Amazon Aurora User Guide.</para><para>Constraints:</para><ul><li><para>Must be in the format <c>hh24:mi-hh24:mi</c>.</para></li><li><para>Must be in Universal Coordinated Time (UTC).</para></li><li><para>Must not conflict with the preferred maintenance window.</para></li><li><para>Must be at least 30 minutes.</para></li></ul> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String PreferredBackupWindow { get; set; } #endregion #region Parameter PreferredMaintenanceWindow /// <summary> /// <para> /// <para>The weekly time range during which system maintenance can occur, in Universal Coordinated /// Time (UTC).</para><para>Format: <c>ddd:hh24:mi-ddd:hh24:mi</c></para><para>The default is a 30-minute window selected at random from an 8-hour block of time /// for each Amazon Web Services Region, occurring on a random day of the week. To see /// the time blocks available, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora"> /// Adjusting the Preferred Maintenance Window</a> in the Amazon Aurora User Guide.</para><para>Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.</para><para>Constraints: Minimum 30-minute window.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String PreferredMaintenanceWindow { get; set; } #endregion #region Parameter S3BucketName /// <summary> /// <para> /// <para>The name of the Amazon S3 bucket that contains the data used to create the Amazon /// Aurora DB cluster.</para> /// </para> /// </summary> #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String S3BucketName { get; set; } #endregion #region Parameter S3IngestionRoleArn /// <summary> /// <para> /// <para>The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management /// (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.</para> /// </para> /// </summary> #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String S3IngestionRoleArn { get; set; } #endregion #region Parameter S3Prefix /// <summary> /// <para> /// <para>The prefix for all of the file names that contain the data used to create the Amazon /// Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon /// Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String S3Prefix { get; set; } #endregion #region Parameter ServerlessV2ScalingConfiguration_SecondsUntilAutoPause /// <summary> /// <para> /// <para>Specifies the number of seconds an Aurora Serverless v2 DB instance must be idle before /// Aurora attempts to automatically pause it. </para><para>Specify a value between 300 seconds (five minutes) and 86,400 seconds (one day). The /// default is 300 seconds.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? ServerlessV2ScalingConfiguration_SecondsUntilAutoPause { get; set; } #endregion #region Parameter SourceEngine /// <summary> /// <para> /// <para>The identifier for the database engine that was backed up to create the files stored /// in the Amazon S3 bucket.</para><para>Valid Values: <c>mysql</c></para> /// </para> /// </summary> #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String SourceEngine { get; set; } #endregion #region Parameter SourceEngineVersion /// <summary> /// <para> /// <para>The version of the database that the backup files were created from.</para><para>MySQL versions 5.7 and 8.0 are supported.</para><para>Example: <c>5.7.40</c>, <c>8.0.28</c></para> /// </para> /// </summary> #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String SourceEngineVersion { get; set; } #endregion #region Parameter StorageEncrypted /// <summary> /// <para> /// <para>Specifies whether the restored DB cluster is encrypted.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? StorageEncrypted { get; set; } #endregion #region Parameter StorageType /// <summary> /// <para> /// <para>Specifies the storage type to be associated with the DB cluster.</para><para>Valid Values: <c>aurora</c>, <c>aurora-iopt1</c></para><para>Default: <c>aurora</c></para><para>Valid for: Aurora DB clusters only</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String StorageType { get; set; } #endregion #region Parameter Tag /// <summary> /// <para> /// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Tags")] public Amazon.RDS.Model.Tag[] Tag { get; set; } #endregion #region Parameter VpcSecurityGroupId /// <summary> /// <para> /// <para>A list of EC2 VPC security groups to associate with the restored DB cluster.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("VpcSecurityGroupIds")] public System.String[] VpcSecurityGroupId { get; set; } #endregion #region Parameter Select /// <summary> /// Use the -Select parameter to control the cmdlet output. The default value is 'DBCluster'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RDS.Model.RestoreDBClusterFromS3Response). /// Specifying the name of a property of type Amazon.RDS.Model.RestoreDBClusterFromS3Response will result in that property being returned. /// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public string Select { get; set; } = "DBCluster"; #endregion #region Parameter PassThru /// <summary> /// Changes the cmdlet behavior to return the value passed to the DBClusterIdentifier parameter. /// The -PassThru parameter is deprecated, use -Select '^DBClusterIdentifier' instead. This parameter will be removed in a future version. /// </summary> [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^DBClusterIdentifier' instead. This parameter will be removed in a future version.")] [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter PassThru { get; set; } #endregion #region Parameter Force /// <summary> /// This parameter overrides confirmation prompts to force /// the cmdlet to continue its operation. This parameter should always /// be used with caution. /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter Force { get; set; } #endregion protected override void ProcessRecord() { this._AWSSignerType = "v4"; base.ProcessRecord(); var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.DBClusterIdentifier), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Restore-RDSDBClusterFromS3 (RestoreDBClusterFromS3)")) { return; } var context = new CmdletContext(); // allow for manipulation of parameters prior to loading into context PreExecutionContextLoad(context); #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute if (ParameterWasBound(nameof(this.Select))) { context.Select = CreateSelectDelegate<Amazon.RDS.Model.RestoreDBClusterFromS3Response, RestoreRDSDBClusterFromS3Cmdlet>(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); if (this.PassThru.IsPresent) { throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select)); } } else if (this.PassThru.IsPresent) { context.Select = (response, cmdlet) => this.DBClusterIdentifier; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute if (this.AvailabilityZone != null) { context.AvailabilityZone = new List<System.String>(this.AvailabilityZone); } context.BacktrackWindow = this.BacktrackWindow; context.BackupRetentionPeriod = this.BackupRetentionPeriod; context.CharacterSetName = this.CharacterSetName; context.CopyTagsToSnapshot = this.CopyTagsToSnapshot; context.DatabaseName = this.DatabaseName; context.DBClusterIdentifier = this.DBClusterIdentifier; #if MODULAR if (this.DBClusterIdentifier == null && ParameterWasBound(nameof(this.DBClusterIdentifier))) { WriteWarning("You are passing $null as a value for parameter DBClusterIdentifier which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif context.DBClusterParameterGroupName = this.DBClusterParameterGroupName; context.DBSubnetGroupName = this.DBSubnetGroupName; context.DeletionProtection = this.DeletionProtection; context.Domain = this.Domain; context.DomainIAMRoleName = this.DomainIAMRoleName; if (this.EnableCloudwatchLogsExport != null) { context.EnableCloudwatchLogsExport = new List<System.String>(this.EnableCloudwatchLogsExport); } context.EnableIAMDatabaseAuthentication = this.EnableIAMDatabaseAuthentication; context.Engine = this.Engine; #if MODULAR if (this.Engine == null && ParameterWasBound(nameof(this.Engine))) { WriteWarning("You are passing $null as a value for parameter Engine which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif context.EngineLifecycleSupport = this.EngineLifecycleSupport; context.EngineVersion = this.EngineVersion; context.KmsKeyId = this.KmsKeyId; context.ManageMasterUserPassword = this.ManageMasterUserPassword; context.MasterUsername = this.MasterUsername; #if MODULAR if (this.MasterUsername == null && ParameterWasBound(nameof(this.MasterUsername))) { WriteWarning("You are passing $null as a value for parameter MasterUsername which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif context.MasterUserPassword = this.MasterUserPassword; context.MasterUserSecretKmsKeyId = this.MasterUserSecretKmsKeyId; context.NetworkType = this.NetworkType; context.OptionGroupName = this.OptionGroupName; context.Port = this.Port; context.PreferredBackupWindow = this.PreferredBackupWindow; context.PreferredMaintenanceWindow = this.PreferredMaintenanceWindow; context.S3BucketName = this.S3BucketName; #if MODULAR if (this.S3BucketName == null && ParameterWasBound(nameof(this.S3BucketName))) { WriteWarning("You are passing $null as a value for parameter S3BucketName which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif context.S3IngestionRoleArn = this.S3IngestionRoleArn; #if MODULAR if (this.S3IngestionRoleArn == null && ParameterWasBound(nameof(this.S3IngestionRoleArn))) { WriteWarning("You are passing $null as a value for parameter S3IngestionRoleArn which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif context.S3Prefix = this.S3Prefix; context.ServerlessV2ScalingConfiguration_MaxCapacity = this.ServerlessV2ScalingConfiguration_MaxCapacity; context.ServerlessV2ScalingConfiguration_MinCapacity = this.ServerlessV2ScalingConfiguration_MinCapacity; context.ServerlessV2ScalingConfiguration_SecondsUntilAutoPause = this.ServerlessV2ScalingConfiguration_SecondsUntilAutoPause; context.SourceEngine = this.SourceEngine; #if MODULAR if (this.SourceEngine == null && ParameterWasBound(nameof(this.SourceEngine))) { WriteWarning("You are passing $null as a value for parameter SourceEngine which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif context.SourceEngineVersion = this.SourceEngineVersion; #if MODULAR if (this.SourceEngineVersion == null && ParameterWasBound(nameof(this.SourceEngineVersion))) { WriteWarning("You are passing $null as a value for parameter SourceEngineVersion which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif context.StorageEncrypted = this.StorageEncrypted; context.StorageType = this.StorageType; if (this.Tag != null) { context.Tag = new List<Amazon.RDS.Model.Tag>(this.Tag); } if (this.VpcSecurityGroupId != null) { context.VpcSecurityGroupId = new List<System.String>(this.VpcSecurityGroupId); } // allow further manipulation of loaded context prior to processing PostExecutionContextLoad(context); var output = Execute(context) as CmdletOutput; ProcessOutput(output); } #region IExecutor Members public object Execute(ExecutorContext context) { var cmdletContext = context as CmdletContext; // create request var request = new Amazon.RDS.Model.RestoreDBClusterFromS3Request(); if (cmdletContext.AvailabilityZone != null) { request.AvailabilityZones = cmdletContext.AvailabilityZone; } if (cmdletContext.BacktrackWindow != null) { request.BacktrackWindow = cmdletContext.BacktrackWindow.Value; } if (cmdletContext.BackupRetentionPeriod != null) { request.BackupRetentionPeriod = cmdletContext.BackupRetentionPeriod.Value; } if (cmdletContext.CharacterSetName != null) { request.CharacterSetName = cmdletContext.CharacterSetName; } if (cmdletContext.CopyTagsToSnapshot != null) { request.CopyTagsToSnapshot = cmdletContext.CopyTagsToSnapshot.Value; } if (cmdletContext.DatabaseName != null) { request.DatabaseName = cmdletContext.DatabaseName; } if (cmdletContext.DBClusterIdentifier != null) { request.DBClusterIdentifier = cmdletContext.DBClusterIdentifier; } if (cmdletContext.DBClusterParameterGroupName != null) { request.DBClusterParameterGroupName = cmdletContext.DBClusterParameterGroupName; } if (cmdletContext.DBSubnetGroupName != null) { request.DBSubnetGroupName = cmdletContext.DBSubnetGroupName; } if (cmdletContext.DeletionProtection != null) { request.DeletionProtection = cmdletContext.DeletionProtection.Value; } if (cmdletContext.Domain != null) { request.Domain = cmdletContext.Domain; } if (cmdletContext.DomainIAMRoleName != null) { request.DomainIAMRoleName = cmdletContext.DomainIAMRoleName; } if (cmdletContext.EnableCloudwatchLogsExport != null) { request.EnableCloudwatchLogsExports = cmdletContext.EnableCloudwatchLogsExport; } if (cmdletContext.EnableIAMDatabaseAuthentication != null) { request.EnableIAMDatabaseAuthentication = cmdletContext.EnableIAMDatabaseAuthentication.Value; } if (cmdletContext.Engine != null) { request.Engine = cmdletContext.Engine; } if (cmdletContext.EngineLifecycleSupport != null) { request.EngineLifecycleSupport = cmdletContext.EngineLifecycleSupport; } if (cmdletContext.EngineVersion != null) { request.EngineVersion = cmdletContext.EngineVersion; } if (cmdletContext.KmsKeyId != null) { request.KmsKeyId = cmdletContext.KmsKeyId; } if (cmdletContext.ManageMasterUserPassword != null) { request.ManageMasterUserPassword = cmdletContext.ManageMasterUserPassword.Value; } if (cmdletContext.MasterUsername != null) { request.MasterUsername = cmdletContext.MasterUsername; } if (cmdletContext.MasterUserPassword != null) { request.MasterUserPassword = cmdletContext.MasterUserPassword; } if (cmdletContext.MasterUserSecretKmsKeyId != null) { request.MasterUserSecretKmsKeyId = cmdletContext.MasterUserSecretKmsKeyId; } if (cmdletContext.NetworkType != null) { request.NetworkType = cmdletContext.NetworkType; } if (cmdletContext.OptionGroupName != null) { request.OptionGroupName = cmdletContext.OptionGroupName; } if (cmdletContext.Port != null) { request.Port = cmdletContext.Port.Value; } if (cmdletContext.PreferredBackupWindow != null) { request.PreferredBackupWindow = cmdletContext.PreferredBackupWindow; } if (cmdletContext.PreferredMaintenanceWindow != null) { request.PreferredMaintenanceWindow = cmdletContext.PreferredMaintenanceWindow; } if (cmdletContext.S3BucketName != null) { request.S3BucketName = cmdletContext.S3BucketName; } if (cmdletContext.S3IngestionRoleArn != null) { request.S3IngestionRoleArn = cmdletContext.S3IngestionRoleArn; } if (cmdletContext.S3Prefix != null) { request.S3Prefix = cmdletContext.S3Prefix; } // populate ServerlessV2ScalingConfiguration var requestServerlessV2ScalingConfigurationIsNull = true; request.ServerlessV2ScalingConfiguration = new Amazon.RDS.Model.ServerlessV2ScalingConfiguration(); System.Double? requestServerlessV2ScalingConfiguration_serverlessV2ScalingConfiguration_MaxCapacity = null; if (cmdletContext.ServerlessV2ScalingConfiguration_MaxCapacity != null) { requestServerlessV2ScalingConfiguration_serverlessV2ScalingConfiguration_MaxCapacity = cmdletContext.ServerlessV2ScalingConfiguration_MaxCapacity.Value; } if (requestServerlessV2ScalingConfiguration_serverlessV2ScalingConfiguration_MaxCapacity != null) { request.ServerlessV2ScalingConfiguration.MaxCapacity = requestServerlessV2ScalingConfiguration_serverlessV2ScalingConfiguration_MaxCapacity.Value; requestServerlessV2ScalingConfigurationIsNull = false; } System.Double? requestServerlessV2ScalingConfiguration_serverlessV2ScalingConfiguration_MinCapacity = null; if (cmdletContext.ServerlessV2ScalingConfiguration_MinCapacity != null) { requestServerlessV2ScalingConfiguration_serverlessV2ScalingConfiguration_MinCapacity = cmdletContext.ServerlessV2ScalingConfiguration_MinCapacity.Value; } if (requestServerlessV2ScalingConfiguration_serverlessV2ScalingConfiguration_MinCapacity != null) { request.ServerlessV2ScalingConfiguration.MinCapacity = requestServerlessV2ScalingConfiguration_serverlessV2ScalingConfiguration_MinCapacity.Value; requestServerlessV2ScalingConfigurationIsNull = false; } System.Int32? requestServerlessV2ScalingConfiguration_serverlessV2ScalingConfiguration_SecondsUntilAutoPause = null; if (cmdletContext.ServerlessV2ScalingConfiguration_SecondsUntilAutoPause != null) { requestServerlessV2ScalingConfiguration_serverlessV2ScalingConfiguration_SecondsUntilAutoPause = cmdletContext.ServerlessV2ScalingConfiguration_SecondsUntilAutoPause.Value; } if (requestServerlessV2ScalingConfiguration_serverlessV2ScalingConfiguration_SecondsUntilAutoPause != null) { request.ServerlessV2ScalingConfiguration.SecondsUntilAutoPause = requestServerlessV2ScalingConfiguration_serverlessV2ScalingConfiguration_SecondsUntilAutoPause.Value; requestServerlessV2ScalingConfigurationIsNull = false; } // determine if request.ServerlessV2ScalingConfiguration should be set to null if (requestServerlessV2ScalingConfigurationIsNull) { request.ServerlessV2ScalingConfiguration = null; } if (cmdletContext.SourceEngine != null) { request.SourceEngine = cmdletContext.SourceEngine; } if (cmdletContext.SourceEngineVersion != null) { request.SourceEngineVersion = cmdletContext.SourceEngineVersion; } if (cmdletContext.StorageEncrypted != null) { request.StorageEncrypted = cmdletContext.StorageEncrypted.Value; } if (cmdletContext.StorageType != null) { request.StorageType = cmdletContext.StorageType; } if (cmdletContext.Tag != null) { request.Tags = cmdletContext.Tag; } if (cmdletContext.VpcSecurityGroupId != null) { request.VpcSecurityGroupIds = cmdletContext.VpcSecurityGroupId; } CmdletOutput output; // issue call var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); try { var response = CallAWSServiceOperation(client, request); object pipelineOutput = null; pipelineOutput = cmdletContext.Select(response, this); output = new CmdletOutput { PipelineOutput = pipelineOutput, ServiceResponse = response }; } catch (Exception e) { output = new CmdletOutput { ErrorResponse = e }; } return output; } public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.RDS.Model.RestoreDBClusterFromS3Response CallAWSServiceOperation(IAmazonRDS client, Amazon.RDS.Model.RestoreDBClusterFromS3Request request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Relational Database Service", "RestoreDBClusterFromS3"); try { #if DESKTOP return client.RestoreDBClusterFromS3(request); #elif CORECLR return client.RestoreDBClusterFromS3Async(request).GetAwaiter().GetResult(); #else #error "Unknown build edition" #endif } catch (AmazonServiceException exc) { var webException = exc.InnerException as System.Net.WebException; if (webException != null) { throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException); } throw; } } #endregion internal partial class CmdletContext : ExecutorContext { public List<System.String> AvailabilityZone { get; set; } public System.Int64? BacktrackWindow { get; set; } public System.Int32? BackupRetentionPeriod { get; set; } public System.String CharacterSetName { get; set; } public System.Boolean? CopyTagsToSnapshot { get; set; } public System.String DatabaseName { get; set; } public System.String DBClusterIdentifier { get; set; } public System.String DBClusterParameterGroupName { get; set; } public System.String DBSubnetGroupName { get; set; } public System.Boolean? DeletionProtection { get; set; } public System.String Domain { get; set; } public System.String DomainIAMRoleName { get; set; } public List<System.String> EnableCloudwatchLogsExport { get; set; } public System.Boolean? EnableIAMDatabaseAuthentication { get; set; } public System.String Engine { get; set; } public System.String EngineLifecycleSupport { get; set; } public System.String EngineVersion { get; set; } public System.String KmsKeyId { get; set; } public System.Boolean? ManageMasterUserPassword { get; set; } public System.String MasterUsername { get; set; } public System.String MasterUserPassword { get; set; } public System.String MasterUserSecretKmsKeyId { get; set; } public System.String NetworkType { get; set; } public System.String OptionGroupName { get; set; } public System.Int32? Port { get; set; } public System.String PreferredBackupWindow { get; set; } public System.String PreferredMaintenanceWindow { get; set; } public System.String S3BucketName { get; set; } public System.String S3IngestionRoleArn { get; set; } public System.String S3Prefix { get; set; } public System.Double? ServerlessV2ScalingConfiguration_MaxCapacity { get; set; } public System.Double? ServerlessV2ScalingConfiguration_MinCapacity { get; set; } public System.Int32? ServerlessV2ScalingConfiguration_SecondsUntilAutoPause { get; set; } public System.String SourceEngine { get; set; } public System.String SourceEngineVersion { get; set; } public System.Boolean? StorageEncrypted { get; set; } public System.String StorageType { get; set; } public List<Amazon.RDS.Model.Tag> Tag { get; set; } public List<System.String> VpcSecurityGroupId { get; set; } public System.Func<Amazon.RDS.Model.RestoreDBClusterFromS3Response, RestoreRDSDBClusterFromS3Cmdlet, object> Select { get; set; } = (response, cmdlet) => response.DBCluster; } } }

modules/AWSPowerShell/Cmdlets/RDS/Basic/Restore-RDSDBClusterFromS3-Cmdlet.cs (646 lines of code) (raw):