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 AWS Glue RegisterConnectionType API operation.

Syntax

Register-GLUEConnectionType
-ConnectionProperties_AdditionalRequestParameter <ConnectorProperty[]>
-ConnectionProperties_Url_AllowedValue <String[]>
-ConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Password_AllowedValue <String[]>
-ConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Username_AllowedValue <String[]>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCode_AllowedValue <String[]>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCodeUrl_AllowedValue <String[]>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientId_AllowedValue <String[]>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientSecret_AllowedValue <String[]>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Prompt_AllowedValue <String[]>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_RedirectUri_AllowedValue <String[]>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Scope_AllowedValue <String[]>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_TokenUrl_AllowedValue <String[]>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientId_AllowedValue <String[]>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientSecret_AllowedValue <String[]>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_Scope_AllowedValue <String[]>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_TokenUrl_AllowedValue <String[]>
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_JwtToken_AllowedValue <String[]>
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_TokenUrl_AllowedValue <String[]>
-ConnectorAuthenticationConfiguration_CustomAuthenticationProperties_AuthenticationParameter <ConnectorProperty[]>
-ConnectorAuthenticationConfiguration_AuthenticationType <String[]>
-ConnectionType <String>
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_CursorConfiguration_LimitParameter_Value_ContentPath <String>
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_CursorConfiguration_NextPage_Value_ContentPath <String>
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_OffsetConfiguration_LimitParameter_Value_ContentPath <String>
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_OffsetConfiguration_OffsetParameter_Value_ContentPath <String>
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_CursorConfiguration_LimitParameter_Value_ContentPath <String>
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_CursorConfiguration_NextPage_Value_ContentPath <String>
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_OffsetConfiguration_LimitParameter_Value_ContentPath <String>
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_OffsetConfiguration_OffsetParameter_Value_ContentPath <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ContentType <ContentType>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ContentType <ContentType>
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_ContentType <ContentType>
-ConnectionProperties_Url_DefaultValue <String>
-ConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Password_DefaultValue <String>
-ConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Username_DefaultValue <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCode_DefaultValue <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCodeUrl_DefaultValue <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientId_DefaultValue <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientSecret_DefaultValue <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Prompt_DefaultValue <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_RedirectUri_DefaultValue <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Scope_DefaultValue <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_TokenUrl_DefaultValue <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientId_DefaultValue <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientSecret_DefaultValue <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_Scope_DefaultValue <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_TokenUrl_DefaultValue <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_JwtToken_DefaultValue <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_TokenUrl_DefaultValue <String>
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_CursorConfiguration_LimitParameter_DefaultValue <String>
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_CursorConfiguration_NextPage_DefaultValue <String>
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_OffsetConfiguration_LimitParameter_DefaultValue <String>
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_OffsetConfiguration_OffsetParameter_DefaultValue <String>
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_CursorConfiguration_LimitParameter_DefaultValue <String>
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_CursorConfiguration_NextPage_DefaultValue <String>
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_OffsetConfiguration_LimitParameter_DefaultValue <String>
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_OffsetConfiguration_OffsetParameter_DefaultValue <String>
-Description <String>
-RestConfiguration_EntityConfiguration <Hashtable>
-RestConfiguration_GlobalSourceConfiguration_ResponseConfiguration_ErrorPath <String>
-RestConfiguration_ValidationEndpointConfiguration_ResponseConfiguration_ErrorPath <String>
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_CursorConfiguration_LimitParameter_Value_HeaderKey <String>
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_CursorConfiguration_NextPage_Value_HeaderKey <String>
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_OffsetConfiguration_LimitParameter_Value_HeaderKey <String>
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_OffsetConfiguration_OffsetParameter_Value_HeaderKey <String>
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_CursorConfiguration_LimitParameter_Value_HeaderKey <String>
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_CursorConfiguration_NextPage_Value_HeaderKey <String>
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_OffsetConfiguration_LimitParameter_Value_HeaderKey <String>
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_OffsetConfiguration_OffsetParameter_Value_HeaderKey <String>
-IntegrationType <IntegrationType>
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_CursorConfiguration_LimitParameter_Key <String>
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_CursorConfiguration_NextPage_Key <String>
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_OffsetConfiguration_LimitParameter_Key <String>
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_OffsetConfiguration_OffsetParameter_Key <String>
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_CursorConfiguration_LimitParameter_Key <String>
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_CursorConfiguration_NextPage_Key <String>
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_OffsetConfiguration_LimitParameter_Key <String>
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_OffsetConfiguration_OffsetParameter_Key <String>
-ConnectionProperties_Url_KeyOverride <String>
-ConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Password_KeyOverride <String>
-ConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Username_KeyOverride <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCode_KeyOverride <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCodeUrl_KeyOverride <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientId_KeyOverride <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientSecret_KeyOverride <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Prompt_KeyOverride <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_RedirectUri_KeyOverride <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Scope_KeyOverride <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_TokenUrl_KeyOverride <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientId_KeyOverride <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientSecret_KeyOverride <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_Scope_KeyOverride <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_TokenUrl_KeyOverride <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_JwtToken_KeyOverride <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_TokenUrl_KeyOverride <String>
-ConnectionProperties_Url_Name <String>
-ConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Password_Name <String>
-ConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Username_Name <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCode_Name <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCodeUrl_Name <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientId_Name <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientSecret_Name <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Prompt_Name <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_RedirectUri_Name <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Scope_Name <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_TokenUrl_Name <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientId_Name <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientSecret_Name <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_Scope_Name <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_TokenUrl_Name <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_JwtToken_Name <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_TokenUrl_Name <String>
-ConnectorAuthenticationConfiguration_OAuth2Properties_OAuth2GrantType <ConnectorOAuth2GrantType>
-ConnectionProperties_Url_PropertyLocation <PropertyLocation>
-ConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Password_PropertyLocation <PropertyLocation>
-ConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Username_PropertyLocation <PropertyLocation>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCode_PropertyLocation <PropertyLocation>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCodeUrl_PropertyLocation <PropertyLocation>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientId_PropertyLocation <PropertyLocation>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientSecret_PropertyLocation <PropertyLocation>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Prompt_PropertyLocation <PropertyLocation>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_RedirectUri_PropertyLocation <PropertyLocation>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Scope_PropertyLocation <PropertyLocation>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_TokenUrl_PropertyLocation <PropertyLocation>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientId_PropertyLocation <PropertyLocation>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientSecret_PropertyLocation <PropertyLocation>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_Scope_PropertyLocation <PropertyLocation>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_TokenUrl_PropertyLocation <PropertyLocation>
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_JwtToken_PropertyLocation <PropertyLocation>
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_TokenUrl_PropertyLocation <PropertyLocation>
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_CursorConfiguration_LimitParameter_PropertyLocation <PropertyLocation>
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_CursorConfiguration_NextPage_PropertyLocation <PropertyLocation>
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_OffsetConfiguration_LimitParameter_PropertyLocation <PropertyLocation>
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_OffsetConfiguration_OffsetParameter_PropertyLocation <PropertyLocation>
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_CursorConfiguration_LimitParameter_PropertyLocation <PropertyLocation>
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_CursorConfiguration_NextPage_PropertyLocation <PropertyLocation>
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_OffsetConfiguration_LimitParameter_PropertyLocation <PropertyLocation>
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_OffsetConfiguration_OffsetParameter_PropertyLocation <PropertyLocation>
-ConnectionProperties_Url_PropertyType <PropertyType>
-ConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Password_PropertyType <PropertyType>
-ConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Username_PropertyType <PropertyType>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCode_PropertyType <PropertyType>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCodeUrl_PropertyType <PropertyType>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientId_PropertyType <PropertyType>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientSecret_PropertyType <PropertyType>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Prompt_PropertyType <PropertyType>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_RedirectUri_PropertyType <PropertyType>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Scope_PropertyType <PropertyType>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_TokenUrl_PropertyType <PropertyType>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientId_PropertyType <PropertyType>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientSecret_PropertyType <PropertyType>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_Scope_PropertyType <PropertyType>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_TokenUrl_PropertyType <PropertyType>
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_JwtToken_PropertyType <PropertyType>
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_TokenUrl_PropertyType <PropertyType>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_RequestMethod <HTTPMethod>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_RequestMethod <HTTPMethod>
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_RequestMethod <HTTPMethod>
-RestConfiguration_GlobalSourceConfiguration_RequestMethod <HTTPMethod>
-RestConfiguration_ValidationEndpointConfiguration_RequestMethod <HTTPMethod>
-RestConfiguration_GlobalSourceConfiguration_RequestParameter <ConnectorProperty[]>
-RestConfiguration_ValidationEndpointConfiguration_RequestParameter <ConnectorProperty[]>
-RestConfiguration_GlobalSourceConfiguration_RequestPath <String>
-RestConfiguration_ValidationEndpointConfiguration_RequestPath <String>
-ConnectionProperties_Url_Required <Boolean>
-ConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Password_Required <Boolean>
-ConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Username_Required <Boolean>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCode_Required <Boolean>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCodeUrl_Required <Boolean>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientId_Required <Boolean>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientSecret_Required <Boolean>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Prompt_Required <Boolean>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_RedirectUri_Required <Boolean>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Scope_Required <Boolean>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_TokenUrl_Required <Boolean>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientId_Required <Boolean>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientSecret_Required <Boolean>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_Scope_Required <Boolean>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_TokenUrl_Required <Boolean>
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_JwtToken_Required <Boolean>
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_TokenUrl_Required <Boolean>
-RestConfiguration_GlobalSourceConfiguration_ResponseConfiguration_ResultPath <String>
-RestConfiguration_ValidationEndpointConfiguration_ResponseConfiguration_ResultPath <String>
-Tag <Hashtable>
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_TokenUrlParameter <ConnectorProperty[]>
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_TokenUrlParameter <ConnectorProperty[]>
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_TokenUrlParameter <ConnectorProperty[]>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonGlueConfig>

Description

Registers a custom connection type in Glue based on the configuration provided. This operation enables customers to configure custom connectors for any data source with REST-based APIs, eliminating the need for building custom Lambda connectors. The registered connection type stores details about how requests and responses are interpreted by REST sources, including connection properties, authentication configuration, and REST configuration with entity definitions. Once registered, customers can create connections using this connection type and work with them the same way as natively supported Glue connectors. Supports multiple authentication types including Basic, OAuth2 (Client Credentials, JWT Bearer, Authorization Code), and Custom Auth configurations.

Parameters

-ClientConfig <AmazonGlueConfig>
Amazon.PowerShell.Cmdlets.GLUE.AmazonGlueClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectionProperties_AdditionalRequestParameter <ConnectorProperty[]>
Key-value pairs of additional request parameters that may be needed during connection creation, such as API versions or service-specific configuration options.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConnectionProperties_AdditionalRequestParameters
-ConnectionProperties_Url_AllowedValue <String[]>
A list of AllowedValue objects representing the values allowed for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConnectionProperties_Url_AllowedValues
-ConnectionProperties_Url_DefaultValue <String>
The default value for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectionProperties_Url_KeyOverride <String>
A key name to use when sending this property in API requests, if different from the display name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectionProperties_Url_Name <String>
The name of the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectionProperties_Url_PropertyLocation <PropertyLocation>
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectionProperties_Url_PropertyType <PropertyType>
The data type of this property
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectionProperties_Url_Required <Boolean>
Indicates whether the property is required.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectionType <String>
The name of the connection type. Must be between 1 and 255 characters and must be prefixed with "REST-" to indicate it is a REST-based connector.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_AuthenticationType <String[]>
A list of authentication types supported by this connection type, such as Basic, OAuth2, or Custom authentication methods.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConnectorAuthenticationConfiguration_AuthenticationTypes
-ConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Password_AllowedValue <String[]>
A list of AllowedValue objects representing the values allowed for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Password_AllowedValues
-ConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Password_DefaultValue <String>
The default value for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Password_KeyOverride <String>
A key name to use when sending this property in API requests, if different from the display name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Password_Name <String>
The name of the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Password_PropertyLocation <PropertyLocation>
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Password_PropertyType <PropertyType>
The data type of this property
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Password_Required <Boolean>
Indicates whether the property is required.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Username_AllowedValue <String[]>
A list of AllowedValue objects representing the values allowed for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Username_AllowedValues
-ConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Username_DefaultValue <String>
The default value for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Username_KeyOverride <String>
A key name to use when sending this property in API requests, if different from the display name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Username_Name <String>
The name of the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Username_PropertyLocation <PropertyLocation>
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Username_PropertyType <PropertyType>
The data type of this property
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_BasicAuthenticationProperties_Username_Required <Boolean>
Indicates whether the property is required.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_CustomAuthenticationProperties_AuthenticationParameter <ConnectorProperty[]>
A map of custom authentication parameters that define the specific authentication mechanism and required properties.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConnectorAuthenticationConfiguration_CustomAuthenticationProperties_AuthenticationParameters
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCode_AllowedValue <String[]>
A list of AllowedValue objects representing the values allowed for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCode_AllowedValues
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCode_DefaultValue <String>
The default value for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCode_KeyOverride <String>
A key name to use when sending this property in API requests, if different from the display name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCode_Name <String>
The name of the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCode_PropertyLocation <PropertyLocation>
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCode_PropertyType <PropertyType>
The data type of this property
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCode_Required <Boolean>
Indicates whether the property is required.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCodeUrl_AllowedValue <String[]>
A list of AllowedValue objects representing the values allowed for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCodeUrl_AllowedValues
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCodeUrl_DefaultValue <String>
The default value for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCodeUrl_KeyOverride <String>
A key name to use when sending this property in API requests, if different from the display name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCodeUrl_Name <String>
The name of the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCodeUrl_PropertyLocation <PropertyLocation>
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCodeUrl_PropertyType <PropertyType>
The data type of this property
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCodeUrl_Required <Boolean>
Indicates whether the property is required.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientId_AllowedValue <String[]>
A list of AllowedValue objects representing the values allowed for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientId_AllowedValues
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientId_DefaultValue <String>
The default value for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientId_KeyOverride <String>
A key name to use when sending this property in API requests, if different from the display name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientId_Name <String>
The name of the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientId_PropertyLocation <PropertyLocation>
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientId_PropertyType <PropertyType>
The data type of this property
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientId_Required <Boolean>
Indicates whether the property is required.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientSecret_AllowedValue <String[]>
A list of AllowedValue objects representing the values allowed for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientSecret_AllowedValues
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientSecret_DefaultValue <String>
The default value for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientSecret_KeyOverride <String>
A key name to use when sending this property in API requests, if different from the display name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientSecret_Name <String>
The name of the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientSecret_PropertyLocation <PropertyLocation>
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientSecret_PropertyType <PropertyType>
The data type of this property
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ClientSecret_Required <Boolean>
Indicates whether the property is required.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_ContentType <ContentType>
The content type to use for token exchange requests, such as application/x-www-form-urlencoded or application/json.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Prompt_AllowedValue <String[]>
A list of AllowedValue objects representing the values allowed for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Prompt_AllowedValues
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Prompt_DefaultValue <String>
The default value for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Prompt_KeyOverride <String>
A key name to use when sending this property in API requests, if different from the display name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Prompt_Name <String>
The name of the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Prompt_PropertyLocation <PropertyLocation>
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Prompt_PropertyType <PropertyType>
The data type of this property
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Prompt_Required <Boolean>
Indicates whether the property is required.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_RedirectUri_AllowedValue <String[]>
A list of AllowedValue objects representing the values allowed for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_RedirectUri_AllowedValues
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_RedirectUri_DefaultValue <String>
The default value for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_RedirectUri_KeyOverride <String>
A key name to use when sending this property in API requests, if different from the display name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_RedirectUri_Name <String>
The name of the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_RedirectUri_PropertyLocation <PropertyLocation>
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_RedirectUri_PropertyType <PropertyType>
The data type of this property
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_RedirectUri_Required <Boolean>
Indicates whether the property is required.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_RequestMethod <HTTPMethod>
The HTTP method to use when making token exchange requests, typically POST.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Scope_AllowedValue <String[]>
A list of AllowedValue objects representing the values allowed for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Scope_AllowedValues
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Scope_DefaultValue <String>
The default value for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Scope_KeyOverride <String>
A key name to use when sending this property in API requests, if different from the display name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Scope_Name <String>
The name of the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Scope_PropertyLocation <PropertyLocation>
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Scope_PropertyType <PropertyType>
The data type of this property
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_Scope_Required <Boolean>
Indicates whether the property is required.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_TokenUrl_AllowedValue <String[]>
A list of AllowedValue objects representing the values allowed for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_TokenUrl_AllowedValues
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_TokenUrl_DefaultValue <String>
The default value for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_TokenUrl_KeyOverride <String>
A key name to use when sending this property in API requests, if different from the display name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_TokenUrl_Name <String>
The name of the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_TokenUrl_PropertyLocation <PropertyLocation>
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_TokenUrl_PropertyType <PropertyType>
The data type of this property
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_TokenUrl_Required <Boolean>
Indicates whether the property is required.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_TokenUrlParameter <ConnectorProperty[]>
Additional parameters to include in token URL requests as key-value pairs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConnectorAuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_TokenUrlParameters
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientId_AllowedValue <String[]>
A list of AllowedValue objects representing the values allowed for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientId_AllowedValues
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientId_DefaultValue <String>
The default value for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientId_KeyOverride <String>
A key name to use when sending this property in API requests, if different from the display name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientId_Name <String>
The name of the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientId_PropertyLocation <PropertyLocation>
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientId_PropertyType <PropertyType>
The data type of this property
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientId_Required <Boolean>
Indicates whether the property is required.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientSecret_AllowedValue <String[]>
A list of AllowedValue objects representing the values allowed for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientSecret_AllowedValues
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientSecret_DefaultValue <String>
The default value for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientSecret_KeyOverride <String>
A key name to use when sending this property in API requests, if different from the display name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientSecret_Name <String>
The name of the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientSecret_PropertyLocation <PropertyLocation>
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientSecret_PropertyType <PropertyType>
The data type of this property
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ClientSecret_Required <Boolean>
Indicates whether the property is required.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_ContentType <ContentType>
The content type to use for token requests, such as application/x-www-form-urlencoded or application/json.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_RequestMethod <HTTPMethod>
The HTTP method to use when making token requests, typically POST.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_Scope_AllowedValue <String[]>
A list of AllowedValue objects representing the values allowed for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_Scope_AllowedValues
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_Scope_DefaultValue <String>
The default value for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_Scope_KeyOverride <String>
A key name to use when sending this property in API requests, if different from the display name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_Scope_Name <String>
The name of the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_Scope_PropertyLocation <PropertyLocation>
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_Scope_PropertyType <PropertyType>
The data type of this property
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_Scope_Required <Boolean>
Indicates whether the property is required.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_TokenUrl_AllowedValue <String[]>
A list of AllowedValue objects representing the values allowed for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_TokenUrl_AllowedValues
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_TokenUrl_DefaultValue <String>
The default value for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_TokenUrl_KeyOverride <String>
A key name to use when sending this property in API requests, if different from the display name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_TokenUrl_Name <String>
The name of the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_TokenUrl_PropertyLocation <PropertyLocation>
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_TokenUrl_PropertyType <PropertyType>
The data type of this property
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_TokenUrl_Required <Boolean>
Indicates whether the property is required.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_TokenUrlParameter <ConnectorProperty[]>
Additional parameters to include in token URL requests as key-value pairs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConnectorAuthenticationConfiguration_OAuth2Properties_ClientCredentialsProperties_TokenUrlParameters
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_ContentType <ContentType>
The content type to use for JWT bearer token requests, such as application/x-www-form-urlencoded or application/json.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_JwtToken_AllowedValue <String[]>
A list of AllowedValue objects representing the values allowed for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_JwtToken_AllowedValues
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_JwtToken_DefaultValue <String>
The default value for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_JwtToken_KeyOverride <String>
A key name to use when sending this property in API requests, if different from the display name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_JwtToken_Name <String>
The name of the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_JwtToken_PropertyLocation <PropertyLocation>
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_JwtToken_PropertyType <PropertyType>
The data type of this property
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_JwtToken_Required <Boolean>
Indicates whether the property is required.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_RequestMethod <HTTPMethod>
The HTTP method to use when making JWT bearer token requests, typically POST.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_TokenUrl_AllowedValue <String[]>
A list of AllowedValue objects representing the values allowed for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_TokenUrl_AllowedValues
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_TokenUrl_DefaultValue <String>
The default value for the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_TokenUrl_KeyOverride <String>
A key name to use when sending this property in API requests, if different from the display name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_TokenUrl_Name <String>
The name of the property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_TokenUrl_PropertyLocation <PropertyLocation>
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_TokenUrl_PropertyType <PropertyType>
The data type of this property
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_TokenUrl_Required <Boolean>
Indicates whether the property is required.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_TokenUrlParameter <ConnectorProperty[]>
Additional parameters to include in token URL requests as key-value pairs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConnectorAuthenticationConfiguration_OAuth2Properties_JWTBearerProperties_TokenUrlParameters
-ConnectorAuthenticationConfiguration_OAuth2Properties_OAuth2GrantType <ConnectorOAuth2GrantType>
The OAuth2 grant type to use for authentication, such as CLIENT_CREDENTIALS, JWT_BEARER, or AUTHORIZATION_CODE.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
A description of the connection type. Can be up to 2048 characters and provides details about the purpose and functionality of the connection type.
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)
-IntegrationType <IntegrationType>
The integration type for the connection. Currently only "REST" protocol is supported.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_EntityConfiguration <Hashtable>
A map of entity configurations that define how to interact with different data entities available through the REST API, including their schemas and access patterns.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRestConfiguration_EntityConfigurations
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_CursorConfiguration_LimitParameter_DefaultValue <String>
The default value to use if the parameter cannot be extracted from the response.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_CursorConfiguration_LimitParameter_Key <String>
The parameter key name that will be used in subsequent requests.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_CursorConfiguration_LimitParameter_PropertyLocation <PropertyLocation>
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_CursorConfiguration_LimitParameter_Value_ContentPath <String>
A JSON path expression that specifies how to extract a value from the response body content.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_CursorConfiguration_LimitParameter_Value_HeaderKey <String>
The name of an HTTP response header from which to extract the value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_CursorConfiguration_NextPage_DefaultValue <String>
The default value to use if the parameter cannot be extracted from the response.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_CursorConfiguration_NextPage_Key <String>
The parameter key name that will be used in subsequent requests.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_CursorConfiguration_NextPage_PropertyLocation <PropertyLocation>
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_CursorConfiguration_NextPage_Value_ContentPath <String>
A JSON path expression that specifies how to extract a value from the response body content.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_CursorConfiguration_NextPage_Value_HeaderKey <String>
The name of an HTTP response header from which to extract the value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_OffsetConfiguration_LimitParameter_DefaultValue <String>
The default value to use if the parameter cannot be extracted from the response.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_OffsetConfiguration_LimitParameter_Key <String>
The parameter key name that will be used in subsequent requests.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_OffsetConfiguration_LimitParameter_PropertyLocation <PropertyLocation>
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_OffsetConfiguration_LimitParameter_Value_ContentPath <String>
A JSON path expression that specifies how to extract a value from the response body content.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_OffsetConfiguration_LimitParameter_Value_HeaderKey <String>
The name of an HTTP response header from which to extract the value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_OffsetConfiguration_OffsetParameter_DefaultValue <String>
The default value to use if the parameter cannot be extracted from the response.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_OffsetConfiguration_OffsetParameter_Key <String>
The parameter key name that will be used in subsequent requests.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_OffsetConfiguration_OffsetParameter_PropertyLocation <PropertyLocation>
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_OffsetConfiguration_OffsetParameter_Value_ContentPath <String>
A JSON path expression that specifies how to extract a value from the response body content.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_GlobalSourceConfiguration_PaginationConfiguration_OffsetConfiguration_OffsetParameter_Value_HeaderKey <String>
The name of an HTTP response header from which to extract the value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_GlobalSourceConfiguration_RequestMethod <HTTPMethod>
The HTTP method to use for requests to this endpoint, such as GET, POST.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_GlobalSourceConfiguration_RequestParameter <ConnectorProperty[]>
Configuration for request parameters that should be included in API calls, such as query parameters, headers, or body content.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRestConfiguration_GlobalSourceConfiguration_RequestParameters
-RestConfiguration_GlobalSourceConfiguration_RequestPath <String>
The URL path for the REST endpoint, which may include parameter placeholders that will be replaced with actual values during requests.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_GlobalSourceConfiguration_ResponseConfiguration_ErrorPath <String>
The JSON path expression that identifies where error information is located within API responses when requests fail.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_GlobalSourceConfiguration_ResponseConfiguration_ResultPath <String>
The JSON path expression that identifies where the actual result data is located within the API response.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_CursorConfiguration_LimitParameter_DefaultValue <String>
The default value to use if the parameter cannot be extracted from the response.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_CursorConfiguration_LimitParameter_Key <String>
The parameter key name that will be used in subsequent requests.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_CursorConfiguration_LimitParameter_PropertyLocation <PropertyLocation>
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_CursorConfiguration_LimitParameter_Value_ContentPath <String>
A JSON path expression that specifies how to extract a value from the response body content.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_CursorConfiguration_LimitParameter_Value_HeaderKey <String>
The name of an HTTP response header from which to extract the value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_CursorConfiguration_NextPage_DefaultValue <String>
The default value to use if the parameter cannot be extracted from the response.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_CursorConfiguration_NextPage_Key <String>
The parameter key name that will be used in subsequent requests.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_CursorConfiguration_NextPage_PropertyLocation <PropertyLocation>
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_CursorConfiguration_NextPage_Value_ContentPath <String>
A JSON path expression that specifies how to extract a value from the response body content.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_CursorConfiguration_NextPage_Value_HeaderKey <String>
The name of an HTTP response header from which to extract the value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_OffsetConfiguration_LimitParameter_DefaultValue <String>
The default value to use if the parameter cannot be extracted from the response.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_OffsetConfiguration_LimitParameter_Key <String>
The parameter key name that will be used in subsequent requests.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_OffsetConfiguration_LimitParameter_PropertyLocation <PropertyLocation>
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_OffsetConfiguration_LimitParameter_Value_ContentPath <String>
A JSON path expression that specifies how to extract a value from the response body content.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_OffsetConfiguration_LimitParameter_Value_HeaderKey <String>
The name of an HTTP response header from which to extract the value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_OffsetConfiguration_OffsetParameter_DefaultValue <String>
The default value to use if the parameter cannot be extracted from the response.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_OffsetConfiguration_OffsetParameter_Key <String>
The parameter key name that will be used in subsequent requests.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_OffsetConfiguration_OffsetParameter_PropertyLocation <PropertyLocation>
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_OffsetConfiguration_OffsetParameter_Value_ContentPath <String>
A JSON path expression that specifies how to extract a value from the response body content.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_ValidationEndpointConfiguration_PaginationConfiguration_OffsetConfiguration_OffsetParameter_Value_HeaderKey <String>
The name of an HTTP response header from which to extract the value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_ValidationEndpointConfiguration_RequestMethod <HTTPMethod>
The HTTP method to use for requests to this endpoint, such as GET, POST.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_ValidationEndpointConfiguration_RequestParameter <ConnectorProperty[]>
Configuration for request parameters that should be included in API calls, such as query parameters, headers, or body content.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRestConfiguration_ValidationEndpointConfiguration_RequestParameters
-RestConfiguration_ValidationEndpointConfiguration_RequestPath <String>
The URL path for the REST endpoint, which may include parameter placeholders that will be replaced with actual values during requests.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_ValidationEndpointConfiguration_ResponseConfiguration_ErrorPath <String>
The JSON path expression that identifies where error information is located within API responses when requests fail.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestConfiguration_ValidationEndpointConfiguration_ResponseConfiguration_ResultPath <String>
The JSON path expression that identifies where the actual result data is located within the API response.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ConnectionTypeArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Glue.Model.RegisterConnectionTypeResponse). Specifying the name of a property of type Amazon.Glue.Model.RegisterConnectionTypeResponse 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>
The tags you assign to the connection type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

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

System.String or Amazon.Glue.Model.RegisterConnectionTypeResponse
This cmdlet returns a System.String object. The service call response (type Amazon.Glue.Model.RegisterConnectionTypeResponse) can be returned by specifying '-Select *'.
Developer Resources
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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