/*******************************************************************************
* Copyright 2012-2019 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
{
///
/// Creates a new DB instance that acts as a read replica for an existing source DB instance
/// or Multi-AZ DB cluster. You can create a read replica for a DB instance running MySQL,
/// MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a Multi-AZ
/// DB cluster running MySQL or PostgreSQL. For more information, see Working
/// with read replicas and Migrating
/// from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon
/// RDS User Guide.
///
///
///
/// Amazon Aurora doesn't support this operation. Call the CreateDBInstance
/// operation to create a DB instance for an Aurora DB cluster.
///
/// All read replica DB instances are created with backups disabled. All other attributes
/// (including DB security groups and DB parameter groups) are inherited from the source
/// DB instance or cluster, except as specified.
///
/// Your source DB instance or cluster must have backup retention enabled.
///
///
[Cmdlet("New", "RDSDBInstanceReadReplica", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.RDS.Model.DBInstance")]
[AWSCmdlet("Calls the Amazon Relational Database Service CreateDBInstanceReadReplica API operation.", Operation = new[] {"CreateDBInstanceReadReplica"}, SelectReturnType = typeof(Amazon.RDS.Model.CreateDBInstanceReadReplicaResponse))]
[AWSCmdletOutput("Amazon.RDS.Model.DBInstance or Amazon.RDS.Model.CreateDBInstanceReadReplicaResponse",
"This cmdlet returns an Amazon.RDS.Model.DBInstance object.",
"The service call response (type Amazon.RDS.Model.CreateDBInstanceReadReplicaResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewRDSDBInstanceReadReplicaCmdlet : AmazonRDSClientCmdlet, IExecutor
{
#region Parameter AllocatedStorage
///
///
/// The amount of storage (in gibibytes) to allocate initially for the read replica. Follow
/// the allocation rules specified in CreateDBInstance
.Be sure to allocate enough storage for your read replica so that the create operation
/// can succeed. You can also allocate additional storage for future growth.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Int32? AllocatedStorage { get; set; }
#endregion
#region Parameter AutoMinorVersionUpgrade
///
///
/// A value that indicates whether minor engine upgrades are applied automatically to
/// the read replica during the maintenance window.This setting doesn't apply to RDS Custom.Default: Inherits from the source DB instance
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? AutoMinorVersionUpgrade { get; set; }
#endregion
#region Parameter AvailabilityZone
///
///
/// The Availability Zone (AZ) where the read replica will be created.Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services
/// Region.Example: us-east-1d
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String AvailabilityZone { get; set; }
#endregion
#region Parameter CopyTagsToSnapshot
///
///
/// A value that indicates whether to copy all tags from the read replica to snapshots
/// of the read replica. By default, tags are not copied.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? CopyTagsToSnapshot { get; set; }
#endregion
#region Parameter CustomIamInstanceProfile
///
///
/// The instance profile associated with the underlying Amazon EC2 instance of an RDS
/// Custom DB instance. The instance profile must meet the following requirements:- The profile must exist in your account.
- The profile must have an IAM role that Amazon EC2 has permissions to assume.
- The instance profile name and the associated IAM role name must start with the prefix
///
AWSRDSCustom
.
For the list of permissions required for the IAM role, see
/// Configure IAM and your VPC in the Amazon RDS User Guide.This setting is required for RDS Custom.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String CustomIamInstanceProfile { get; set; }
#endregion
#region Parameter DBInstanceClass
///
///
/// The compute and memory capacity of the read replica, for example db.m4.large. Not
/// all DB instance classes are available in all Amazon Web Services Regions, or for all
/// database engines. For the full list of DB instance classes, and availability for your
/// engine, see DB
/// Instance Class in the Amazon RDS User Guide.Default: Inherits from the source DB instance.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String DBInstanceClass { get; set; }
#endregion
#region Parameter DBInstanceIdentifier
///
///
/// The DB instance identifier of the read replica. This identifier is the unique key
/// that identifies a DB instance. This parameter is stored as a lowercase string.
///
///
#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 DBInstanceIdentifier { get; set; }
#endregion
#region Parameter DBParameterGroupName
///
///
/// The name of the DB parameter group to associate with this DB instance.If you do not specify a value for DBParameterGroupName
, then Amazon RDS
/// uses the DBParameterGroup
of source DB instance for a same Region read
/// replica, or the default DBParameterGroup
for the specified DB engine
/// for a cross-Region read replica.Specifying a parameter group for this operation is only supported for MySQL and Oracle
/// DB instances. It isn't supported for RDS Custom.Constraints:- Must be 1 to 255 letters, numbers, or hyphens.
- First character must be a letter
- Can't end with a hyphen or contain two consecutive hyphens
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String DBParameterGroupName { get; set; }
#endregion
#region Parameter DBSubnetGroupName
///
///
/// Specifies a DB subnet group for the DB instance. The new DB instance is created in
/// the VPC associated with the DB subnet group. If no DB subnet group is specified, then
/// the new DB instance isn't created in a VPC.Constraints:- If supplied, must match the name of an existing DBSubnetGroup.
- The specified DB subnet group must be in the same Amazon Web Services Region in which
/// the operation is running.
- All read replicas in one Amazon Web Services Region that are created from the same
/// source DB instance must either:>
- Specify DB subnet groups from the same VPC. All these read replicas are created in
/// the same VPC.
- Not specify a DB subnet group. All these read replicas are created outside of any
/// VPC.
Example: mydbsubnetgroup
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String DBSubnetGroupName { get; set; }
#endregion
#region Parameter DeletionProtection
///
///
/// A value that indicates whether the DB instance has deletion protection enabled. The
/// database can't be deleted when deletion protection is enabled. By default, deletion
/// protection isn't enabled. For more information, see
/// Deleting a DB Instance.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? DeletionProtection { get; set; }
#endregion
#region Parameter Domain
///
///
/// The Active Directory directory ID to create the DB instance in. Currently, only MySQL,
/// Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active
/// Directory Domain.For more information, see
/// Kerberos Authentication in the Amazon RDS User Guide.This setting doesn't apply to RDS Custom.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Domain { get; set; }
#endregion
#region Parameter DomainAuthSecretArn
///
///
/// The ARN for the Secrets Manager secret with the credentials for the user joining the
/// domain.Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String DomainAuthSecretArn { get; set; }
#endregion
#region Parameter DomainDnsIp
///
///
/// 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
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("DomainDnsIps")]
public System.String[] DomainDnsIp { get; set; }
#endregion
#region Parameter DomainFqdn
///
///
/// The fully qualified domain name (FQDN) of an Active Directory domain.Constraints:- Can't be longer than 64 characters.
Example: mymanagedADtest.mymanagedAD.mydomain
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String DomainFqdn { get; set; }
#endregion
#region Parameter DomainIAMRoleName
///
///
/// The name of the IAM role to be used when making API calls to the Directory Service.This setting doesn't apply to RDS Custom.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String DomainIAMRoleName { get; set; }
#endregion
#region Parameter DomainOu
///
///
/// The Active Directory organizational unit for your DB instance to join.Constraints:- Must be in the distinguished name format.
- Can't be longer than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String DomainOu { get; set; }
#endregion
#region Parameter EnableCloudwatchLogsExport
///
///
/// The list of logs that the new DB instance is to export to CloudWatch Logs. The values
/// in the list depend on the DB engine being used. For more information, see Publishing
/// Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.This setting doesn't apply to RDS Custom.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("EnableCloudwatchLogsExports")]
public System.String[] EnableCloudwatchLogsExport { get; set; }
#endregion
#region Parameter EnableCustomerOwnedIp
///
///
/// A value that indicates whether to enable a customer-owned IP address (CoIP) for an
/// RDS on Outposts read replica.A CoIP provides local or external connectivity to resources in your Outpost
/// subnets through your on-premises network. For some use cases, a CoIP can provide lower
/// latency for connections to the read replica from outside of its virtual private cloud
/// (VPC) on your local network.For more information about RDS on Outposts, see Working
/// with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.For more information about CoIPs, see Customer-owned
/// IP addresses in the Amazon Web Services Outposts User Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? EnableCustomerOwnedIp { get; set; }
#endregion
#region Parameter EnableIAMDatabaseAuthentication
///
///
/// 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.For more information about IAM database authentication, see
/// IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User
/// Guide.This setting doesn't apply to RDS Custom.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? EnableIAMDatabaseAuthentication { get; set; }
#endregion
#region Parameter EnablePerformanceInsight
///
///
/// A value that indicates whether to enable Performance Insights for the read replica.For more information, see Using
/// Amazon Performance Insights in the Amazon RDS User Guide.This setting doesn't apply to RDS Custom.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("EnablePerformanceInsights")]
public System.Boolean? EnablePerformanceInsight { get; set; }
#endregion
#region Parameter Iops
///
///
/// The amount of Provisioned IOPS (input/output operations per second) to be initially
/// allocated for the DB instance.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Int32? Iops { get; set; }
#endregion
#region Parameter KmsKeyId
///
///
/// The Amazon Web Services KMS key identifier for an encrypted read replica.The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias
/// name for the KMS key.If you create an encrypted read replica in the same Amazon Web Services Region as
/// the source DB instance or Multi-AZ DB cluster, don't specify a value for this parameter.
/// A read replica in the same Amazon Web Services Region is always encrypted with the
/// same KMS key as the source DB instance or cluster.If you create an encrypted read replica in a different Amazon Web Services Region,
/// then you must specify a KMS key identifier for the destination Amazon Web Services
/// Region. KMS keys are specific to the Amazon Web Services Region that they are created
/// in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon
/// Web Services Region.You can't create an encrypted read replica from an unencrypted DB instance or Multi-AZ
/// DB cluster.This setting doesn't apply to RDS Custom, which uses the same KMS key as the primary
/// replica.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String KmsKeyId { get; set; }
#endregion
#region Parameter MaxAllocatedStorage
///
///
/// The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the
/// storage of the DB instance.For more information about this setting, including limitations that apply to it, see
///
/// Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon
/// RDS User Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Int32? MaxAllocatedStorage { get; set; }
#endregion
#region Parameter MonitoringInterval
///
///
/// The interval, in seconds, between points when Enhanced Monitoring metrics are collected
/// for the read replica. To disable collecting Enhanced Monitoring metrics, specify 0.
/// The default is 0.If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
/// to a value other than 0.This setting doesn't apply to RDS Custom.Valid Values: 0, 1, 5, 10, 15, 30, 60
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Int32? MonitoringInterval { get; set; }
#endregion
#region Parameter MonitoringRoleArn
///
///
/// The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon
/// CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess
.
/// For information on creating a monitoring role, go to To
/// create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User
/// Guide.If MonitoringInterval
is set to a value other than 0, then you must supply
/// a MonitoringRoleArn
value.This setting doesn't apply to RDS Custom.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String MonitoringRoleArn { get; set; }
#endregion
#region Parameter MultiAZ
///
///
/// A value that indicates whether the read replica is in a Multi-AZ deployment.You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of
/// your replica in another Availability Zone for failover support for the replica. Creating
/// your read replica as a Multi-AZ DB instance is independent of whether the source is
/// a Multi-AZ DB instance or a Multi-AZ DB cluster.This setting doesn't apply to RDS Custom.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? MultiAZ { get; set; }
#endregion
#region Parameter NetworkType
///
///
/// The network type of the DB instance.Valid values:The network type is determined by the DBSubnetGroup
specified for read
/// replica. A DBSubnetGroup
can support only the IPv4 protocol or the IPv4
/// and the IPv6 protocols (DUAL
).For more information, see
/// Working with a DB instance in a VPC in the Amazon RDS User Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String NetworkType { get; set; }
#endregion
#region Parameter OptionGroupName
///
///
/// The option group the DB instance is associated with. If omitted, the option group
/// associated with the source instance or cluster is used.For SQL Server, you must use the option group associated with the source.This setting doesn't apply to RDS Custom.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String OptionGroupName { get; set; }
#endregion
#region Parameter PerformanceInsightsKMSKeyId
///
///
/// The Amazon Web Services KMS key identifier for encryption of Performance Insights
/// data.The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias
/// name for the KMS key.If you do not specify a value for PerformanceInsightsKMSKeyId
, then Amazon
/// RDS uses 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.This setting doesn't apply to RDS Custom.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String PerformanceInsightsKMSKeyId { get; set; }
#endregion
#region Parameter PerformanceInsightsRetentionPeriod
///
///
/// The number of days to retain Performance Insights data. The default is 7 days. The
/// following values are valid:- 7
- month * 31, where month is a number of months from 1-23
- 731
For example, the following values are valid:- 93 (3 months * 31)
- 341 (11 months * 31)
- 589 (19 months * 31)
- 731
If you specify a retention period such as 94, which isn't a valid value, RDS issues
/// an error.This setting doesn't apply to RDS Custom.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Int32? PerformanceInsightsRetentionPeriod { get; set; }
#endregion
#region Parameter Port
///
///
/// The port number that the DB instance uses for connections.Default: Inherits from the source DB instanceValid Values: 1150-65535
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Int32? Port { get; set; }
#endregion
#region Parameter PreSignedUrl
///
///
/// When you are creating a read replica from one Amazon Web Services GovCloud (US) Region
/// to another or from one China Amazon Web Services Region to another, the URL that contains
/// a Signature Version 4 signed request for the CreateDBInstanceReadReplica
/// API operation in the source Amazon Web Services Region that contains the source DB
/// instance.This setting applies only to Amazon Web Services GovCloud (US) Regions and China Amazon
/// Web Services Regions. It's ignored in other Amazon Web Services Regions.This setting applies only when replicating from a source DB instance. Source
/// DB clusters aren't supported in Amazon Web Services GovCloud (US) Regions and China
/// Amazon Web Services Regions.You must specify this parameter when you create an encrypted read replica from another
/// Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl
/// when you are creating an encrypted read replica in the same Amazon Web Services Region.The presigned URL must be a valid request for the CreateDBInstanceReadReplica
/// API operation that can run in the source Amazon Web Services Region that contains
/// the encrypted source DB instance. The presigned URL request must contain the following
/// parameter values:DestinationRegion
- The Amazon Web Services Region that the encrypted
/// read replica is created in. This Amazon Web Services Region is the same one where
/// the CreateDBInstanceReadReplica
operation is called that contains this
/// presigned URL.For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services
/// Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then
/// you call the CreateDBInstanceReadReplica
operation in the us-east-1 Amazon
/// Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica
/// operation in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion
/// in the presigned URL must be set to the us-east-1 Amazon Web Services Region.KmsKeyId
- The KMS key identifier for the key to use to encrypt the
/// read replica in the destination Amazon Web Services Region. This is the same identifier
/// for both the CreateDBInstanceReadReplica
operation that is called in
/// the destination Amazon Web Services Region, and the operation contained in the presigned
/// URL.SourceDBInstanceIdentifier
- The DB instance identifier for the encrypted
/// DB instance to be replicated. This identifier must be in the Amazon Resource Name
/// (ARN) format for the source Amazon Web Services Region. For example, if you are creating
/// an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services
/// Region, then your SourceDBInstanceIdentifier
looks like the following
/// example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115
.
To learn how to generate a Signature Version 4 signed request, see Authenticating
/// Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and
/// Signature
/// Version 4 Signing Process.If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion
/// (or --source-region
for the CLI) instead of specifying PreSignedUrl
/// manually. Specifying SourceRegion
autogenerates a presigned URL that
/// is a valid request for the operation that can run in the source Amazon Web Services
/// Region.SourceRegion
isn't supported for SQL Server, because Amazon RDS for
/// SQL Server doesn't support cross-Region read replicas.This setting doesn't apply to RDS Custom.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String PreSignedUrl { get; set; }
#endregion
#region Parameter ProcessorFeature
///
///
/// The number of CPU cores and the number of threads per core for the DB instance class
/// of the DB instance.This setting doesn't apply to RDS Custom.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("ProcessorFeatures")]
public Amazon.RDS.Model.ProcessorFeature[] ProcessorFeature { get; set; }
#endregion
#region Parameter PubliclyAccessible
///
///
/// A value that indicates whether the DB instance is publicly accessible.When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint
/// resolves to the private IP address from within the DB cluster's virtual private cloud
/// (VPC). It resolves to the public IP address from outside of the DB cluster's VPC.
/// Access to the DB cluster is ultimately controlled by the security group it uses. That
/// public access isn't permitted if the security group assigned to the DB cluster doesn't
/// permit it.When the DB instance isn't publicly accessible, it is an internal DB instance with
/// a DNS name that resolves to a private IP address.For more information, see CreateDBInstance.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? PubliclyAccessible { get; set; }
#endregion
#region Parameter ReplicaMode
///
///
/// The open mode of the replica database: mounted or read-only.This parameter is only supported for Oracle DB instances.Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use
/// case for mounted replicas is cross-Region disaster recovery. The primary database
/// doesn't use Active Data Guard to transmit information to the mounted replica. Because
/// it doesn't accept user connections, a mounted replica can't serve a read-only workload.You can create a combination of mounted and read-only DB replicas for the same primary
/// DB instance. For more information, see Working
/// with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.For RDS Custom, you must specify this parameter and set it to mounted
.
/// The value won't be set by default. After replica creation, you can manage the open
/// mode manually.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.RDS.ReplicaMode")]
public Amazon.RDS.ReplicaMode ReplicaMode { get; set; }
#endregion
#region Parameter SourceDBClusterIdentifier
///
///
/// The identifier of the Multi-AZ DB cluster that will act as the source for the read
/// replica. Each DB cluster can have up to 15 read replicas.Constraints:- Must be the identifier of an existing Multi-AZ DB cluster.
- Can't be specified if the
SourceDBInstanceIdentifier
parameter is also
/// specified. - The specified DB cluster must have automatic backups enabled, that is, its backup
/// retention period must be greater than 0.
- The source DB cluster must be in the same Amazon Web Services Region as the read replica.
/// Cross-Region replication isn't supported.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String SourceDBClusterIdentifier { get; set; }
#endregion
#region Parameter SourceDBInstanceIdentifier
///
///
/// The identifier of the DB instance that will act as the source for the read replica.
/// Each DB instance can have up to 15 read replicas, with the exception of Oracle and
/// SQL Server, which can have up to five.Constraints:- Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server
/// DB instance.
- Can't be specified if the
SourceDBClusterIdentifier
parameter is also
/// specified. - For the limitations of Oracle read replicas, see Version
/// and licensing considerations for RDS for Oracle replicas in the Amazon RDS
/// User Guide.
- For the limitations of SQL Server read replicas, see Read
/// replica limitations with SQL Server in the Amazon RDS User Guide.
- The specified DB instance must have automatic backups enabled, that is, its backup
/// retention period must be greater than 0.
- If the source DB instance is in the same Amazon Web Services Region as the read replica,
/// specify a valid DB instance identifier.
- If the source DB instance is in a different Amazon Web Services Region from the read
/// replica, specify a valid DB instance ARN. For more information, see Constructing
/// an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn't apply
/// to SQL Server or RDS Custom, which don't support cross-Region replicas.
///
///
[System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)]
public System.String SourceDBInstanceIdentifier { get; set; }
#endregion
#region Parameter SourceRegion
///
///
/// The SourceRegion for generating the PreSignedUrl property.
///
/// If SourceRegion is set and the PreSignedUrl property is not,
/// then PreSignedUrl will be automatically generated by the client.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String SourceRegion { get; set; }
#endregion
#region Parameter StorageThroughput
///
///
/// Specifies the storage throughput value for the read replica.This setting doesn't apply to RDS Custom or Amazon Aurora.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Int32? StorageThroughput { get; set; }
#endregion
#region Parameter StorageType
///
///
/// Specifies the storage type to be associated with the read replica.Valid values: gp2 | gp3 | io1 | standard
If you specify io1
or gp3
, you must also include a value
/// for the Iops
parameter.Default: io1
if the Iops
parameter is specified, otherwise
/// gp2
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String StorageType { get; set; }
#endregion
#region Parameter Tag
///
///
/// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Tags")]
public Amazon.RDS.Model.Tag[] Tag { get; set; }
#endregion
#region Parameter UseDefaultProcessorFeature
///
///
/// A value that indicates whether the DB instance class of the DB instance uses its default
/// processor features.This setting doesn't apply to RDS Custom.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("UseDefaultProcessorFeatures")]
public System.Boolean? UseDefaultProcessorFeature { get; set; }
#endregion
#region Parameter VpcSecurityGroupId
///
///
/// A list of Amazon EC2 VPC security groups to associate with the read replica.This setting doesn't apply to RDS Custom.Default: The default EC2 VPC security group for the DB subnet group's VPC.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("VpcSecurityGroupIds")]
public System.String[] VpcSecurityGroupId { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'DBInstance'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RDS.Model.CreateDBInstanceReadReplicaResponse).
/// Specifying the name of a property of type Amazon.RDS.Model.CreateDBInstanceReadReplicaResponse will result in that property being returned.
/// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "DBInstance";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the DBInstanceIdentifier parameter.
/// The -PassThru parameter is deprecated, use -Select '^DBInstanceIdentifier' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^DBInstanceIdentifier' 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
///
/// This parameter overrides confirmation prompts to force
/// the cmdlet to continue its operation. This parameter should always
/// be used with caution.
///
[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.DBInstanceIdentifier), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-RDSDBInstanceReadReplica (CreateDBInstanceReadReplica)"))
{
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(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.DBInstanceIdentifier;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.SourceRegion = this.SourceRegion;
context.AllocatedStorage = this.AllocatedStorage;
context.AutoMinorVersionUpgrade = this.AutoMinorVersionUpgrade;
context.AvailabilityZone = this.AvailabilityZone;
context.CopyTagsToSnapshot = this.CopyTagsToSnapshot;
context.CustomIamInstanceProfile = this.CustomIamInstanceProfile;
context.DBInstanceClass = this.DBInstanceClass;
context.DBInstanceIdentifier = this.DBInstanceIdentifier;
#if MODULAR
if (this.DBInstanceIdentifier == null && ParameterWasBound(nameof(this.DBInstanceIdentifier)))
{
WriteWarning("You are passing $null as a value for parameter DBInstanceIdentifier 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.DBParameterGroupName = this.DBParameterGroupName;
context.DBSubnetGroupName = this.DBSubnetGroupName;
context.DeletionProtection = this.DeletionProtection;
context.Domain = this.Domain;
context.DomainAuthSecretArn = this.DomainAuthSecretArn;
if (this.DomainDnsIp != null)
{
context.DomainDnsIp = new List(this.DomainDnsIp);
}
context.DomainFqdn = this.DomainFqdn;
context.DomainIAMRoleName = this.DomainIAMRoleName;
context.DomainOu = this.DomainOu;
if (this.EnableCloudwatchLogsExport != null)
{
context.EnableCloudwatchLogsExport = new List(this.EnableCloudwatchLogsExport);
}
context.EnableCustomerOwnedIp = this.EnableCustomerOwnedIp;
context.EnableIAMDatabaseAuthentication = this.EnableIAMDatabaseAuthentication;
context.EnablePerformanceInsight = this.EnablePerformanceInsight;
context.Iops = this.Iops;
context.KmsKeyId = this.KmsKeyId;
context.MaxAllocatedStorage = this.MaxAllocatedStorage;
context.MonitoringInterval = this.MonitoringInterval;
context.MonitoringRoleArn = this.MonitoringRoleArn;
context.MultiAZ = this.MultiAZ;
context.NetworkType = this.NetworkType;
context.OptionGroupName = this.OptionGroupName;
context.PerformanceInsightsKMSKeyId = this.PerformanceInsightsKMSKeyId;
context.PerformanceInsightsRetentionPeriod = this.PerformanceInsightsRetentionPeriod;
context.Port = this.Port;
context.PreSignedUrl = this.PreSignedUrl;
if (this.ProcessorFeature != null)
{
context.ProcessorFeature = new List(this.ProcessorFeature);
}
context.PubliclyAccessible = this.PubliclyAccessible;
context.ReplicaMode = this.ReplicaMode;
context.SourceDBClusterIdentifier = this.SourceDBClusterIdentifier;
context.SourceDBInstanceIdentifier = this.SourceDBInstanceIdentifier;
context.StorageThroughput = this.StorageThroughput;
context.StorageType = this.StorageType;
if (this.Tag != null)
{
context.Tag = new List(this.Tag);
}
context.UseDefaultProcessorFeature = this.UseDefaultProcessorFeature;
if (this.VpcSecurityGroupId != null)
{
context.VpcSecurityGroupId = new List(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.CreateDBInstanceReadReplicaRequest();
if (cmdletContext.SourceRegion != null)
{
request.SourceRegion = cmdletContext.SourceRegion;
}
if (cmdletContext.AllocatedStorage != null)
{
request.AllocatedStorage = cmdletContext.AllocatedStorage.Value;
}
if (cmdletContext.AutoMinorVersionUpgrade != null)
{
request.AutoMinorVersionUpgrade = cmdletContext.AutoMinorVersionUpgrade.Value;
}
if (cmdletContext.AvailabilityZone != null)
{
request.AvailabilityZone = cmdletContext.AvailabilityZone;
}
if (cmdletContext.CopyTagsToSnapshot != null)
{
request.CopyTagsToSnapshot = cmdletContext.CopyTagsToSnapshot.Value;
}
if (cmdletContext.CustomIamInstanceProfile != null)
{
request.CustomIamInstanceProfile = cmdletContext.CustomIamInstanceProfile;
}
if (cmdletContext.DBInstanceClass != null)
{
request.DBInstanceClass = cmdletContext.DBInstanceClass;
}
if (cmdletContext.DBInstanceIdentifier != null)
{
request.DBInstanceIdentifier = cmdletContext.DBInstanceIdentifier;
}
if (cmdletContext.DBParameterGroupName != null)
{
request.DBParameterGroupName = cmdletContext.DBParameterGroupName;
}
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.DomainAuthSecretArn != null)
{
request.DomainAuthSecretArn = cmdletContext.DomainAuthSecretArn;
}
if (cmdletContext.DomainDnsIp != null)
{
request.DomainDnsIps = cmdletContext.DomainDnsIp;
}
if (cmdletContext.DomainFqdn != null)
{
request.DomainFqdn = cmdletContext.DomainFqdn;
}
if (cmdletContext.DomainIAMRoleName != null)
{
request.DomainIAMRoleName = cmdletContext.DomainIAMRoleName;
}
if (cmdletContext.DomainOu != null)
{
request.DomainOu = cmdletContext.DomainOu;
}
if (cmdletContext.EnableCloudwatchLogsExport != null)
{
request.EnableCloudwatchLogsExports = cmdletContext.EnableCloudwatchLogsExport;
}
if (cmdletContext.EnableCustomerOwnedIp != null)
{
request.EnableCustomerOwnedIp = cmdletContext.EnableCustomerOwnedIp.Value;
}
if (cmdletContext.EnableIAMDatabaseAuthentication != null)
{
request.EnableIAMDatabaseAuthentication = cmdletContext.EnableIAMDatabaseAuthentication.Value;
}
if (cmdletContext.EnablePerformanceInsight != null)
{
request.EnablePerformanceInsights = cmdletContext.EnablePerformanceInsight.Value;
}
if (cmdletContext.Iops != null)
{
request.Iops = cmdletContext.Iops.Value;
}
if (cmdletContext.KmsKeyId != null)
{
request.KmsKeyId = cmdletContext.KmsKeyId;
}
if (cmdletContext.MaxAllocatedStorage != null)
{
request.MaxAllocatedStorage = cmdletContext.MaxAllocatedStorage.Value;
}
if (cmdletContext.MonitoringInterval != null)
{
request.MonitoringInterval = cmdletContext.MonitoringInterval.Value;
}
if (cmdletContext.MonitoringRoleArn != null)
{
request.MonitoringRoleArn = cmdletContext.MonitoringRoleArn;
}
if (cmdletContext.MultiAZ != null)
{
request.MultiAZ = cmdletContext.MultiAZ.Value;
}
if (cmdletContext.NetworkType != null)
{
request.NetworkType = cmdletContext.NetworkType;
}
if (cmdletContext.OptionGroupName != null)
{
request.OptionGroupName = cmdletContext.OptionGroupName;
}
if (cmdletContext.PerformanceInsightsKMSKeyId != null)
{
request.PerformanceInsightsKMSKeyId = cmdletContext.PerformanceInsightsKMSKeyId;
}
if (cmdletContext.PerformanceInsightsRetentionPeriod != null)
{
request.PerformanceInsightsRetentionPeriod = cmdletContext.PerformanceInsightsRetentionPeriod.Value;
}
if (cmdletContext.Port != null)
{
request.Port = cmdletContext.Port.Value;
}
if (cmdletContext.PreSignedUrl != null)
{
request.PreSignedUrl = cmdletContext.PreSignedUrl;
}
if (cmdletContext.ProcessorFeature != null)
{
request.ProcessorFeatures = cmdletContext.ProcessorFeature;
}
if (cmdletContext.PubliclyAccessible != null)
{
request.PubliclyAccessible = cmdletContext.PubliclyAccessible.Value;
}
if (cmdletContext.ReplicaMode != null)
{
request.ReplicaMode = cmdletContext.ReplicaMode;
}
if (cmdletContext.SourceDBClusterIdentifier != null)
{
request.SourceDBClusterIdentifier = cmdletContext.SourceDBClusterIdentifier;
}
if (cmdletContext.SourceDBInstanceIdentifier != null)
{
request.SourceDBInstanceIdentifier = cmdletContext.SourceDBInstanceIdentifier;
}
if (cmdletContext.StorageThroughput != null)
{
request.StorageThroughput = cmdletContext.StorageThroughput.Value;
}
if (cmdletContext.StorageType != null)
{
request.StorageType = cmdletContext.StorageType;
}
if (cmdletContext.Tag != null)
{
request.Tags = cmdletContext.Tag;
}
if (cmdletContext.UseDefaultProcessorFeature != null)
{
request.UseDefaultProcessorFeatures = cmdletContext.UseDefaultProcessorFeature.Value;
}
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.CreateDBInstanceReadReplicaResponse CallAWSServiceOperation(IAmazonRDS client, Amazon.RDS.Model.CreateDBInstanceReadReplicaRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Relational Database Service", "CreateDBInstanceReadReplica");
try
{
#if DESKTOP
return client.CreateDBInstanceReadReplica(request);
#elif CORECLR
return client.CreateDBInstanceReadReplicaAsync(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 System.String SourceRegion { get; set; }
public System.Int32? AllocatedStorage { get; set; }
public System.Boolean? AutoMinorVersionUpgrade { get; set; }
public System.String AvailabilityZone { get; set; }
public System.Boolean? CopyTagsToSnapshot { get; set; }
public System.String CustomIamInstanceProfile { get; set; }
public System.String DBInstanceClass { get; set; }
public System.String DBInstanceIdentifier { get; set; }
public System.String DBParameterGroupName { get; set; }
public System.String DBSubnetGroupName { get; set; }
public System.Boolean? DeletionProtection { get; set; }
public System.String Domain { get; set; }
public System.String DomainAuthSecretArn { get; set; }
public List DomainDnsIp { get; set; }
public System.String DomainFqdn { get; set; }
public System.String DomainIAMRoleName { get; set; }
public System.String DomainOu { get; set; }
public List EnableCloudwatchLogsExport { get; set; }
public System.Boolean? EnableCustomerOwnedIp { get; set; }
public System.Boolean? EnableIAMDatabaseAuthentication { get; set; }
public System.Boolean? EnablePerformanceInsight { get; set; }
public System.Int32? Iops { get; set; }
public System.String KmsKeyId { get; set; }
public System.Int32? MaxAllocatedStorage { get; set; }
public System.Int32? MonitoringInterval { get; set; }
public System.String MonitoringRoleArn { get; set; }
public System.Boolean? MultiAZ { get; set; }
public System.String NetworkType { get; set; }
public System.String OptionGroupName { get; set; }
public System.String PerformanceInsightsKMSKeyId { get; set; }
public System.Int32? PerformanceInsightsRetentionPeriod { get; set; }
public System.Int32? Port { get; set; }
public System.String PreSignedUrl { get; set; }
public List ProcessorFeature { get; set; }
public System.Boolean? PubliclyAccessible { get; set; }
public Amazon.RDS.ReplicaMode ReplicaMode { get; set; }
public System.String SourceDBClusterIdentifier { get; set; }
public System.String SourceDBInstanceIdentifier { get; set; }
public System.Int32? StorageThroughput { get; set; }
public System.String StorageType { get; set; }
public List Tag { get; set; }
public System.Boolean? UseDefaultProcessorFeature { get; set; }
public List VpcSecurityGroupId { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.DBInstance;
}
}
}