< Back

New-GcSqlInstanceReplicaConfig

Mon Jan 13, 2020 11:33 pm

NAME New-GcSqlInstanceReplicaConfig



SYNOPSIS

Creates a configuration for a replicaConfiguration.





SYNTAX

New-GcSqlInstanceReplicaConfig [-FailoverTarget <SwitchParameter>] [-MySqlCaCert <string>] [-MySqlClientCert

<string>] [-MySqlClientKey <string>] [-MySqlRetryInterval <int>] [-MySqlDumpPath <string>] [-MySqlHeartbeatPeriod

<long>] [-MySqlPassword <string>] [-MySqlSslCipher <string>] [-MySqlUser <string>] [-MySqlVerifyCertificate

<SwitchParameter>] [<CommonParameters>]





DESCRIPTION

Creates a configuration for a replicaConfiguration. Can be pipelined into New-GcSqlInstanceConfig.



NOTE: If any parameter is incorrect/invalid, this cmdlet not fail. You will only receive an error once you try to

update or add an instance with this configuration to your project.





PARAMETERS

-FailoverTarget <SwitchParameter>

Specifies if the replica is the failover target. If the field is set to true the replica will be designated as

a failover replica. In case the master instance fails, the replica instance will be promoted as the new master

instance.



Only one replica can be specified as failover target, and the replica has to be in different zone with the

master instance.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-MySqlCaCert <string>

PEM representation of the trusted CA????????s x509 certificate.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-MySqlClientCert <string>

PEM representation of the slave????????s x509 certificate.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-MySqlClientKey <string>

PEM representation of the slave????????s private key. The corresponding public key is encoded in the client????????s

certificate.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-MySqlRetryInterval <int>

Seconds to wait between connect retries. The default is 60 seconds.



Required? false

Position? named

Default value 60

Accept pipeline input? false

Accept wildcard characters? false



-MySqlDumpPath <string>

Path to a SQL dump file in Google Cloud Storage from which the slave instance is to be created. The URI is in

the form "gs://bucketName/fileName". Compressed gzip files (.gz) are also supported. Dumps should have the

binlog co-ordinates from which replication should begin. This can be accomplished by setting --master-data to

1 when using mysqldump.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-MySqlHeartbeatPeriod <long>

Interval in milliseconds between replication heartbeats. Defaults to 20 seconds.



Required? false

Position? named

Default value 20000

Accept pipeline input? false

Accept wildcard characters? false



-MySqlPassword <string>

The password for the replication connection.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-MySqlSslCipher <string>

A list of permissible ciphers to use for SSL encryption.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-MySqlUser <string>

The username for the replication connection.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-MySqlVerifyCertificate <SwitchParameter>

Whether or not to check the master????????s Common Name value in the certificate that it sends during the SSL

handshake.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

Google.Apis.SQLAdmin.v1beta4.Data.ReplicaConfiguration





---------- EXAMPLE 1 ----------



PS C:\\> New-GcSqlInstanceReplicaConfig



Creates a basic replica configuration resource with default values.

---------- EXAMPLE 2 ----------



PS C:\\> New-GcSqlInstanceReplicaConfig -MySqlRetryInterval 10



Creates a basic replica configuration resource with a retry interval of 10 seconds.



RELATED LINKS

[Setting up Instances] (https://cloud.google.com/tools/powershe ... /sql/setup)

[Replica Instances] (https://cloud.google.com/tools/powershe ... ql/replica)

[Replication Options] (https://cloud.google.com/sql/docs/replication/)

[Replication Requirements and Tips] (https://cloud.google.com/sql/docs/replication/tips)