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 Oracle Database@Amazon Web Services UpdateAutonomousDatabase API operation.

Syntax

Update-ODBAutonomousDatabase
-AutonomousDatabaseId <String>
-AdminPassword <String>
-AllowlistedIp <String[]>
-AutonomousMaintenanceScheduleType <AutonomousMaintenanceScheduleType>
-AutoRefreshFrequencyInSecond <Int32>
-AutoRefreshPointLagInSecond <Int32>
-ResourcePoolSummary_AvailableComputeCapacity <Int32>
-ResourcePoolSummary_AvailableStorageCapacityInTBs <Double>
-BackupRetentionPeriodInDay <Int32>
-ByolComputeCountLimit <Double>
-ComputeCount <Double>
-CpuCoreCount <Int32>
-CustomerContactsToSendToOCI <CustomerContact[]>
-DatabaseEdition <DatabaseEdition>
-DataStorageSizeInGBs <Int32>
-DataStorageSizeInTBs <Int32>
-DbName <String>
-DbToolsDetail <DatabaseTool[]>
-DbVersion <String>
-DbWorkload <DbWorkload>
-DisplayName <String>
-EncryptionKeyProvider <EncryptionKeyProviderInput>
-EncryptionKeyConfiguration_AwsEncryptionKey_ExternalIdType <ExternalIdType>
-EncryptionKeyConfiguration_AwsEncryptionKey_IamRoleArn <String>
-IsAutoScalingEnabled <Boolean>
-IsAutoScalingForStorageEnabled <Boolean>
-IsBackupRetentionLocked <Boolean>
-LongTermBackupSchedule_IsDisabled <Boolean>
-ResourcePoolSummary_IsDisabled <Boolean>
-IsDisconnectPeer <Boolean>
-IsLocalDataGuardEnabled <Boolean>
-IsMtlsConnectionRequired <Boolean>
-IsRefreshableClone <Boolean>
-EncryptionKeyConfiguration_AwsEncryptionKey_KmsKeyId <String>
-LicenseModel <LicenseModel>
-LocalAdgAutoFailoverMaxDataLossLimit <Int32>
-OpenMode <OpenMode>
-PeerDbId <String>
-PermissionLevel <PermissionLevel>
-ResourcePoolSummary_PoolSize <Int32>
-ResourcePoolSummary_PoolStorageSizeInTBs <Int32>
-PrivateEndpointIp <String>
-PrivateEndpointLabel <String>
-RefreshableMode <RefreshableMode>
-LongTermBackupSchedule_RepeatCadence <RepeatCadence>
-ResourcePoolLeaderId <String>
-LongTermBackupSchedule_RetentionPeriodInDay <Int32>
-ScheduledOperation <ScheduledOperationDetails[]>
-StandbyAllowlistedIp <String[]>
-StandbyAllowlistedIpsSource <StandbyAllowlistedIpsSource>
-TimeOfAutoRefreshStart <DateTime>
-LongTermBackupSchedule_TimeOfBackup <DateTime>
-ResourcePoolSummary_TotalComputeCapacity <Int32>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonOdbConfig>

Description

Updates the properties of an Autonomous Database.

Parameters

-AdminPassword <String>
The new password for the ADMIN user of the Autonomous Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AllowlistedIp <String[]>
The list of IP addresses that are allowed to access the Autonomous Database. 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)
AliasesAllowlistedIps
-AutonomousDatabaseId <String>
The unique identifier of the Autonomous Database to update.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-AutonomousMaintenanceScheduleType <AutonomousMaintenanceScheduleType>
The maintenance schedule type for the Autonomous Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutoRefreshFrequencyInSecond <Int32>
The frequency, in seconds, at which the refreshable clone Autonomous Database is automatically refreshed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoRefreshFrequencyInSeconds
-AutoRefreshPointLagInSecond <Int32>
The time lag, in seconds, between the refreshable clone and its source Autonomous Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoRefreshPointLagInSeconds
-BackupRetentionPeriodInDay <Int32>
The retention period, in days, for automatic backups of the Autonomous Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesBackupRetentionPeriodInDays
-ByolComputeCountLimit <Double>
The maximum number of compute resources that you can allocate to the Autonomous Database under the bring-your-own-license (BYOL) model.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonOdbConfig>
Amazon.PowerShell.Cmdlets.ODB.AmazonOdbClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeCount <Double>
The compute capacity, in number of ECPUs or OCPUs, to assign to the Autonomous Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CpuCoreCount <Int32>
The number of CPU cores to allocate to the Autonomous Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomerContactsToSendToOCI <CustomerContact[]>
The list of customer contacts to receive operational notifications from OCI for the Autonomous Database. 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)
-DatabaseEdition <DatabaseEdition>
The Oracle Database edition to apply to the Autonomous Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataStorageSizeInGBs <Int32>
The size, in gigabytes (GB), of the data volume to allocate for the Autonomous Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataStorageSizeInTBs <Int32>
The size, in terabytes (TB), of the data volume to allocate for the Autonomous Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DbName <String>
The new name of the Autonomous Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DbToolsDetail <DatabaseTool[]>
The list of database management tools to enable for the Autonomous Database. 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)
AliasesDbToolsDetails
-DbVersion <String>
The Oracle Database software version to use for the Autonomous Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DbWorkload <DbWorkload>
The intended use of the Autonomous Database, such as transaction processing, data warehouse, JSON database, or APEX.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DisplayName <String>
The new user-friendly name for the Autonomous Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EncryptionKeyConfiguration_AwsEncryptionKey_ExternalIdType <ExternalIdType>
The type of external identifier associated with the encryption key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EncryptionKeyConfiguration_AwsEncryptionKey_IamRoleArn <String>
The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that grants access to the KMS key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EncryptionKeyConfiguration_AwsEncryptionKey_KmsKeyId <String>
The identifier or ARN of the Amazon Web Services KMS key to use for encryption.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EncryptionKeyProvider <EncryptionKeyProviderInput>
The provider of the encryption key to use for the Autonomous Database.
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)
-IsAutoScalingEnabled <Boolean>
Specifies whether to enable automatic scaling of the compute resources for the Autonomous Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IsAutoScalingForStorageEnabled <Boolean>
Specifies whether to enable automatic scaling of the storage for the Autonomous Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IsBackupRetentionLocked <Boolean>
Specifies whether to lock the backup retention period of the Autonomous Database to prevent it from being shortened.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IsDisconnectPeer <Boolean>
Specifies whether to disconnect the Autonomous Database from its peer database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IsLocalDataGuardEnabled <Boolean>
Specifies whether to enable local Oracle Data Guard for the Autonomous Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IsMtlsConnectionRequired <Boolean>
Specifies whether mutual TLS (mTLS) authentication is required to connect to the Autonomous Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IsRefreshableClone <Boolean>
Specifies whether the Autonomous Database is a refreshable clone.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LicenseModel <LicenseModel>
The Oracle license model to apply to the Autonomous Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LocalAdgAutoFailoverMaxDataLossLimit <Int32>
The maximum data loss limit, in seconds, for automatic failover to the local Oracle Data Guard standby database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LongTermBackupSchedule_IsDisabled <Boolean>
Indicates whether the long-term backup schedule is disabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LongTermBackupSchedule_RepeatCadence <RepeatCadence>
The cadence at which long-term backups are taken.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LongTermBackupSchedule_RetentionPeriodInDay <Int32>
The retention period, in days, for long-term backups.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLongTermBackupSchedule_RetentionPeriodInDays
-LongTermBackupSchedule_TimeOfBackup <DateTime>
The date and time at which the long-term backup is taken.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OpenMode <OpenMode>
The mode in which to open the Autonomous Database, either read-only or read/write.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PeerDbId <String>
The unique identifier of the peer Autonomous Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PermissionLevel <PermissionLevel>
The permission level of the Autonomous Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PrivateEndpointIp <String>
The private endpoint IP address for the Autonomous Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PrivateEndpointLabel <String>
The private endpoint label for the Autonomous Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RefreshableMode <RefreshableMode>
The refresh mode of the refreshable clone Autonomous Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourcePoolLeaderId <String>
The unique identifier of the resource pool leader Autonomous Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourcePoolSummary_AvailableComputeCapacity <Int32>
The available compute capacity in the resource pool.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourcePoolSummary_AvailableStorageCapacityInTBs <Double>
The available storage capacity in the resource pool, in TB.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourcePoolSummary_IsDisabled <Boolean>
Indicates whether the resource pool is disabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourcePoolSummary_PoolSize <Int32>
The number of Autonomous Databases that the resource pool can contain.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourcePoolSummary_PoolStorageSizeInTBs <Int32>
The total storage size of the resource pool, in terabytes (TB).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourcePoolSummary_TotalComputeCapacity <Int32>
The total compute capacity of the resource pool.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScheduledOperation <ScheduledOperationDetails[]>
The list of scheduled start and stop times for the Autonomous Database. 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)
AliasesScheduledOperations
-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.Odb.Model.UpdateAutonomousDatabaseResponse). Specifying the name of a property of type Amazon.Odb.Model.UpdateAutonomousDatabaseResponse 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)
-StandbyAllowlistedIp <String[]>
The list of IP addresses that are allowed to access the standby Autonomous Database. 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)
AliasesStandbyAllowlistedIps
-StandbyAllowlistedIpsSource <StandbyAllowlistedIpsSource>
The source of the allowlisted IP addresses for the standby Autonomous Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TimeOfAutoRefreshStart <DateTime>
The date and time at which the automatic refresh of the refreshable clone Autonomous Database starts.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

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.Odb.Model.UpdateAutonomousDatabaseResponse
This cmdlet returns an Amazon.Odb.Model.UpdateAutonomousDatabaseResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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