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 DataZone UpdateConnection API operation.

Syntax

Update-DZConnection
-Identifier <String>
-AwsLocation_AccessRole <String>
-AmazonQProperties_AuthMode <String>
-AwsLocation_AwsAccountId <String>
-AwsLocation_AwsRegion <String>
-Storage_ClusterName <String>
-SparkEmrProperties_ComputeArn <String>
-GlueConnectionInput_ConnectionProperty <Hashtable>
-RedshiftProperties_DatabaseName <String>
-Description <String>
-GlueConnectionInput_Description <String>
-DomainIdentifier <String>
-LineageSync_Enabled <Boolean>
-IamProperties_GlueLineageSyncEnabled <Boolean>
-RedshiftProperties_Host <String>
-AwsLocation_IamConnectionId <String>
-SparkEmrProperties_InstanceProfileArn <String>
-AmazonQProperties_IsEnabled <Boolean>
-SparkEmrProperties_JavaVirtualEnv <String>
-SparkEmrProperties_LogUri <String>
-SparkEmrProperties_ManagedEndpointArn <String>
-BasicAuthenticationCredentials_Password <String>
-UsernamePassword_Password <String>
-RedshiftProperties_Port <Int32>
-AmazonQProperties_ProfileArn <String>
-SparkEmrProperties_PythonVirtualEnv <String>
-SparkEmrProperties_RuntimeRole <String>
-S3Properties_S3AccessGrantLocationId <String>
-S3Properties_S3Uri <String>
-Schedule_Schedule <String>
-AuthenticationConfiguration_SecretArn <String>
-Credentials_SecretArn <String>
-MlflowProperties_TrackingServerArn <String>
-MlflowProperties_TrackingServerName <String>
-SparkEmrProperties_TrustedCertificatesS3Uri <String>
-UsernamePassword_Username <String>
-BasicAuthenticationCredentials_UserName <String>
-AthenaProperties_WorkgroupName <String>
-Storage_WorkgroupName <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonDataZoneConfig>

Description

Updates a connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

Parameters

-AmazonQProperties_AuthMode <String>
The authentication mode of the connection's Amazon Q properties.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_AmazonQProperties_AuthMode
-AmazonQProperties_IsEnabled <Boolean>
Specifies whether Amazon Q is enabled for the connection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_AmazonQProperties_IsEnabled
-AmazonQProperties_ProfileArn <String>
The profile ARN of the connection's Amazon Q properties.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_AmazonQProperties_ProfileArn
-AthenaProperties_WorkgroupName <String>
The Amazon Athena workgroup name of a connection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_AthenaProperties_WorkgroupName
-AuthenticationConfiguration_SecretArn <String>
The secret ARN of a connection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_GlueProperties_GlueConnectionInput_AuthenticationConfiguration_SecretArn
-AwsLocation_AccessRole <String>
The access role of a connection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AwsLocation_AwsAccountId <String>
The account ID of a connection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AwsLocation_AwsRegion <String>
The Region of a connection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AwsLocation_IamConnectionId <String>
The IAM connection ID of a connection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-BasicAuthenticationCredentials_Password <String>
The password for a connection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_GlueProperties_GlueConnectionInput_AuthenticationConfiguration_BasicAuthenticationCredentials_Password
-BasicAuthenticationCredentials_UserName <String>
The user name for the connecion.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_GlueProperties_GlueConnectionInput_AuthenticationConfiguration_BasicAuthenticationCredentials_UserName
-ClientConfig <AmazonDataZoneConfig>
Amazon.PowerShell.Cmdlets.DZ.AmazonDataZoneClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Credentials_SecretArn <String>
The secret ARN of the Amazon Redshift credentials of a connection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_RedshiftProperties_Credentials_SecretArn
-Description <String>
The description of a connection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DomainIdentifier <String>
The ID of the domain where a connection is to be updated.
Required?True
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)
-GlueConnectionInput_ConnectionProperty <Hashtable>
The properties of the Amazon Web Services Glue connection patch. 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)
AliasesProps_GlueProperties_GlueConnectionInput_ConnectionProperties
-GlueConnectionInput_Description <String>
The description of the Amazon Web Services Glue connection patch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_GlueProperties_GlueConnectionInput_Description
-IamProperties_GlueLineageSyncEnabled <Boolean>
Specifies whether Amazon Web Services Glue lineage sync is enabled for a connection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_IamProperties_GlueLineageSyncEnabled
-Identifier <String>
The ID of the connection to be updated.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-LineageSync_Enabled <Boolean>
Specifies whether the Amaon Redshift lineage sync configuration is enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_RedshiftProperties_LineageSync_Enabled
-MlflowProperties_TrackingServerArn <String>
The tracking server ARN as part of the MLflow properties of a connection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_MlflowProperties_TrackingServerArn
-MlflowProperties_TrackingServerName <String>
The name of the tracking server as part of the MLflow properties of a connection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_MlflowProperties_TrackingServerName
-RedshiftProperties_DatabaseName <String>
The name in the Amazon Redshift properties patch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_RedshiftProperties_DatabaseName
-RedshiftProperties_Host <String>
The host in the Amazon Redshift properties patch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_RedshiftProperties_Host
-RedshiftProperties_Port <Int32>
The port in the Amazon Redshift properties patch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_RedshiftProperties_Port
-S3Properties_S3AccessGrantLocationId <String>
The Amazon S3 Access Grant location ID that's part of the Amazon S3 properties patch of a connection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_S3Properties_S3AccessGrantLocationId
-S3Properties_S3Uri <String>
The Amazon S3 URI that's part of the Amazon S3 properties patch of a connection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_S3Properties_S3Uri
-Schedule_Schedule <String>
The lineage sync schedule.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_RedshiftProperties_LineageSync_Schedule_Schedule
-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.DataZone.Model.UpdateConnectionResponse). Specifying the name of a property of type Amazon.DataZone.Model.UpdateConnectionResponse 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)
-SparkEmrProperties_ComputeArn <String>
The compute ARN in the Spark EMR properties patch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_SparkEmrProperties_ComputeArn
-SparkEmrProperties_InstanceProfileArn <String>
The instance profile ARN in the Spark EMR properties patch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_SparkEmrProperties_InstanceProfileArn
-SparkEmrProperties_JavaVirtualEnv <String>
The Java virtual evn in the Spark EMR properties patch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_SparkEmrProperties_JavaVirtualEnv
-SparkEmrProperties_LogUri <String>
The log URI in the Spark EMR properties patch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_SparkEmrProperties_LogUri
-SparkEmrProperties_ManagedEndpointArn <String>
The managed endpoint ARN of the EMR on EKS cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_SparkEmrProperties_ManagedEndpointArn
-SparkEmrProperties_PythonVirtualEnv <String>
The Python virtual env in the Spark EMR properties patch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_SparkEmrProperties_PythonVirtualEnv
-SparkEmrProperties_RuntimeRole <String>
The runtime role in the Spark EMR properties patch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_SparkEmrProperties_RuntimeRole
-SparkEmrProperties_TrustedCertificatesS3Uri <String>
The trusted certificates S3 URI in the Spark EMR properties patch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_SparkEmrProperties_TrustedCertificatesS3Uri
-Storage_ClusterName <String>
The cluster name in the Amazon Redshift storage properties.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_RedshiftProperties_Storage_ClusterName
-Storage_WorkgroupName <String>
The workgroup name in the Amazon Redshift storage properties.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_RedshiftProperties_Storage_WorkgroupName
-UsernamePassword_Password <String>
The password of a connection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_RedshiftProperties_Credentials_UsernamePassword_Password
-UsernamePassword_Username <String>
The username of a connection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProps_RedshiftProperties_Credentials_UsernamePassword_Username

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

Supported Version

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