AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Timestream InfluxDB RestoreFromDbBackup API operation.

Syntax

Restore-TIDBFromDbBackup
-LogDeliveryConfiguration_S3Configuration_BucketName <String>
-DbBackupConfiguration <DbBackupConfiguration[]>
-DbBackupId <String>
-DeploymentType <ResourceDeploymentType>
-LogDeliveryConfiguration_S3Configuration_Enabled <Boolean>
-KmsKeyId <String>
-Name <String>
-NetworkType <NetworkType>
-Port <Int32>
-MaintenanceSchedule_PreferredMaintenanceWindow <String>
-PubliclyAccessible <Boolean>
-RestoreMode <RestoreMode>
-RestoreToTime <DateTime>
-Tag <Hashtable>
-MaintenanceSchedule_Timezone <String>
-VpcSecurityGroupId <String[]>
-VpcSubnetId <String[]>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonTimestreamInfluxDBConfig>

Description

Restores a Timestream for InfluxDB resource from a backup. By default, a new resource is created. You can optionally restore to the same resource using the REPLACE_EXISTING restore mode.

Parameters

-ClientConfig <AmazonTimestreamInfluxDBConfig>
Amazon.PowerShell.Cmdlets.TIDB.AmazonTimestreamInfluxDBClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DbBackupConfiguration <DbBackupConfiguration[]>
A list of backup configurations to apply to the restored resource. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDbBackupConfigurations
-DbBackupId <String>
The identifier of the backup to restore from.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeploymentType <ResourceDeploymentType>
Specifies the deployment type of the restored resource. Valid values are SINGLE_AZ, WITH_MULTIAZ_STANDBY, and MULTI_NODE_READ_REPLICAS.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KmsKeyId <String>
The Amazon Web Services KMS key identifier to use for encryption of the restored resource. Can be a key ID, key ARN, alias name, or alias ARN.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LogDeliveryConfiguration_S3Configuration_BucketName <String>
The name of the S3 bucket to deliver logs to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LogDeliveryConfiguration_S3Configuration_Enabled <Boolean>
Indicates whether log delivery to the S3 bucket is enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaintenanceSchedule_PreferredMaintenanceWindow <String>
The preferred maintenance window in the format ddd:HH:MM-ddd:HH:MM (UTC). Day must be one of: Mon, Tue, Wed, Thu, Fri, Sat, Sun. For example, Sun:02:00-Sun:06:00. Provide an empty string to let the system choose a window.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaintenanceSchedule_Timezone <String>
The IANA timezone identifier for the maintenance window. Format: Region/City or UTC. For example, America/New_York or UTC.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
The name of the new resource to create from the restore. If restoring to an existing resource, the name must match the existing resource name.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkType <NetworkType>
Specifies the network type of the restored resource. Valid values are IPV4 and DUAL.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Port <Int32>
The port number on which the restored InfluxDB resource accepts connections.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PubliclyAccessible <Boolean>
Specifies whether the restored resource is publicly accessible.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestoreMode <RestoreMode>
Specifies whether to restore to a new resource or replace the existing resource. Valid values are NEW_RESOURCE (default) and REPLACE_EXISTING.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestoreToTime <DateTime>
The point in time to restore to, for continuous backups. Must be within the backup's retention window.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TimestreamInfluxDB.Model.RestoreFromDbBackupResponse). Specifying the name of a property of type Amazon.TimestreamInfluxDB.Model.RestoreFromDbBackupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
A list of key-value pairs to associate with the restored resource. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-VpcSecurityGroupId <String[]>
A list of VPC security group IDs for the restored resource. If not specified, the restored resource uses the same security groups as the backup. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVpcSecurityGroupIds
-VpcSubnetId <String[]>
A list of VPC subnet IDs for the restored resource. If not specified, the restored resource uses the same subnets as the backup. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVpcSubnetIds

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.TimestreamInfluxDB.Model.RestoreFromDbBackupResponse
This cmdlet returns an Amazon.TimestreamInfluxDB.Model.RestoreFromDbBackupResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z