Class ConnectionInput
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ConnectionInput.Builder,
ConnectionInput>
A structure that is used to specify a connection to create or update.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionConnection properties specific to the Athena compute environment.The authentication properties of the connection.static ConnectionInput.Builder
builder()
final Map
<ConnectionPropertyKey, String> These key-value pairs define parameters for the connection.These key-value pairs define parameters for the connection.final ConnectionType
The type of the connection.final String
The type of the connection.final String
The description of the connection.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AthenaProperties property.final boolean
For responses, this returns true if the service returned a value for the ConnectionProperties property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the MatchCriteria property.final boolean
For responses, this returns true if the service returned a value for the PythonProperties property.final boolean
For responses, this returns true if the service returned a value for the SparkProperties property.final boolean
For responses, this returns true if the service returned a value for the ValidateForComputeEnvironments property.A list of criteria that can be used in selecting this connection.final String
name()
The name of the connection.The physical connection requirements, such as virtual private cloud (VPC) andSecurityGroup
, that are needed to successfully make this connection.Connection properties specific to the Python compute environment.static Class
<? extends ConnectionInput.Builder> Connection properties specific to the Spark compute environment.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Boolean
A flag to validate the credentials during create connection.final List
<ComputeEnvironment> The compute environments that the specified connection properties are validated against.The compute environments that the specified connection properties are validated against.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
-
description
The description of the connection.
- Returns:
- The description of the connection.
-
connectionType
The type of the connection. Currently, these types are supported:
-
JDBC
- Designates a connection to a database through Java Database Connectivity (JDBC).JDBC
Connections use the following ConnectionParameters.-
Required: All of (
HOST
,PORT
,JDBC_ENGINE
) orJDBC_CONNECTION_URL
. -
Required: All of (
USERNAME
,PASSWORD
) orSECRET_ID
. -
Optional:
JDBC_ENFORCE_SSL
,CUSTOM_JDBC_CERT
,CUSTOM_JDBC_CERT_STRING
,SKIP_CUSTOM_JDBC_CERT_VALIDATION
. These parameters are used to configure SSL with JDBC.
-
-
KAFKA
- Designates a connection to an Apache Kafka streaming platform.KAFKA
Connections use the following ConnectionParameters.-
Required:
KAFKA_BOOTSTRAP_SERVERS
. -
Optional:
KAFKA_SSL_ENABLED
,KAFKA_CUSTOM_CERT
,KAFKA_SKIP_CUSTOM_CERT_VALIDATION
. These parameters are used to configure SSL withKAFKA
. -
Optional:
KAFKA_CLIENT_KEYSTORE
,KAFKA_CLIENT_KEYSTORE_PASSWORD
,KAFKA_CLIENT_KEY_PASSWORD
,ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD
,ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD
. These parameters are used to configure TLS client configuration with SSL inKAFKA
. -
Optional:
KAFKA_SASL_MECHANISM
. Can be specified asSCRAM-SHA-512
,GSSAPI
, orAWS_MSK_IAM
. -
Optional:
KAFKA_SASL_SCRAM_USERNAME
,KAFKA_SASL_SCRAM_PASSWORD
,ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD
. These parameters are used to configure SASL/SCRAM-SHA-512 authentication withKAFKA
. -
Optional:
KAFKA_SASL_GSSAPI_KEYTAB
,KAFKA_SASL_GSSAPI_KRB5_CONF
,KAFKA_SASL_GSSAPI_SERVICE
,KAFKA_SASL_GSSAPI_PRINCIPAL
. These parameters are used to configure SASL/GSSAPI authentication withKAFKA
.
-
-
MONGODB
- Designates a connection to a MongoDB document database.MONGODB
Connections use the following ConnectionParameters.-
Required:
CONNECTION_URL
. -
Required: All of (
USERNAME
,PASSWORD
) orSECRET_ID
.
-
-
VIEW_VALIDATION_REDSHIFT
- Designates a connection used for view validation by Amazon Redshift. -
VIEW_VALIDATION_ATHENA
- Designates a connection used for view validation by Amazon Athena. -
NETWORK
- Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).NETWORK
Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements. -
MARKETPLACE
- Uses configuration settings contained in a connector purchased from Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by Glue.MARKETPLACE
Connections use the following ConnectionParameters.-
Required:
CONNECTOR_TYPE
,CONNECTOR_URL
,CONNECTOR_CLASS_NAME
,CONNECTION_URL
. -
Required for
JDBC
CONNECTOR_TYPE
connections: All of (USERNAME
,PASSWORD
) orSECRET_ID
.
-
-
CUSTOM
- Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by Glue.
Additionally, a
ConnectionType
for the following SaaS connectors is supported:-
FACEBOOKADS
- Designates a connection to Facebook Ads. -
GOOGLEADS
- Designates a connection to Google Ads. -
GOOGLESHEETS
- Designates a connection to Google Sheets. -
GOOGLEANALYTICS4
- Designates a connection to Google Analytics 4. -
HUBSPOT
- Designates a connection to HubSpot. -
INSTAGRAMADS
- Designates a connection to Instagram Ads. -
INTERCOM
- Designates a connection to Intercom. -
JIRACLOUD
- Designates a connection to Jira Cloud. -
MARKETO
- Designates a connection to Adobe Marketo Engage. -
NETSUITEERP
- Designates a connection to Oracle NetSuite. -
SALESFORCE
- Designates a connection to Salesforce using OAuth authentication. -
SALESFORCEMARKETINGCLOUD
- Designates a connection to Salesforce Marketing Cloud. -
SALESFORCEPARDOT
- Designates a connection to Salesforce Marketing Cloud Account Engagement (MCAE). -
SAPODATA
- Designates a connection to SAP OData. -
SERVICENOW
- Designates a connection to ServiceNow. -
SLACK
- Designates a connection to Slack. -
SNAPCHATADS
- Designates a connection to Snapchat Ads. -
STRIPE
- Designates a connection to Stripe. -
ZENDESK
- Designates a connection to Zendesk. -
ZOHOCRM
- Designates a connection to Zoho CRM.
For more information on the connection parameters needed for a particular connector, see the documentation for the connector in Adding an Glue connectionin the Glue User Guide.
SFTP
is not supported.For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties.
For more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections.
If the service returns an enum value that is not available in the current SDK version,
connectionType
will returnConnectionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconnectionTypeAsString()
.- Returns:
- The type of the connection. Currently, these types are supported:
-
JDBC
- Designates a connection to a database through Java Database Connectivity (JDBC).JDBC
Connections use the following ConnectionParameters.-
Required: All of (
HOST
,PORT
,JDBC_ENGINE
) orJDBC_CONNECTION_URL
. -
Required: All of (
USERNAME
,PASSWORD
) orSECRET_ID
. -
Optional:
JDBC_ENFORCE_SSL
,CUSTOM_JDBC_CERT
,CUSTOM_JDBC_CERT_STRING
,SKIP_CUSTOM_JDBC_CERT_VALIDATION
. These parameters are used to configure SSL with JDBC.
-
-
KAFKA
- Designates a connection to an Apache Kafka streaming platform.KAFKA
Connections use the following ConnectionParameters.-
Required:
KAFKA_BOOTSTRAP_SERVERS
. -
Optional:
KAFKA_SSL_ENABLED
,KAFKA_CUSTOM_CERT
,KAFKA_SKIP_CUSTOM_CERT_VALIDATION
. These parameters are used to configure SSL withKAFKA
. -
Optional:
KAFKA_CLIENT_KEYSTORE
,KAFKA_CLIENT_KEYSTORE_PASSWORD
,KAFKA_CLIENT_KEY_PASSWORD
,ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD
,ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD
. These parameters are used to configure TLS client configuration with SSL inKAFKA
. -
Optional:
KAFKA_SASL_MECHANISM
. Can be specified asSCRAM-SHA-512
,GSSAPI
, orAWS_MSK_IAM
. -
Optional:
KAFKA_SASL_SCRAM_USERNAME
,KAFKA_SASL_SCRAM_PASSWORD
,ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD
. These parameters are used to configure SASL/SCRAM-SHA-512 authentication withKAFKA
. -
Optional:
KAFKA_SASL_GSSAPI_KEYTAB
,KAFKA_SASL_GSSAPI_KRB5_CONF
,KAFKA_SASL_GSSAPI_SERVICE
,KAFKA_SASL_GSSAPI_PRINCIPAL
. These parameters are used to configure SASL/GSSAPI authentication withKAFKA
.
-
-
MONGODB
- Designates a connection to a MongoDB document database.MONGODB
Connections use the following ConnectionParameters.-
Required:
CONNECTION_URL
. -
Required: All of (
USERNAME
,PASSWORD
) orSECRET_ID
.
-
-
VIEW_VALIDATION_REDSHIFT
- Designates a connection used for view validation by Amazon Redshift. -
VIEW_VALIDATION_ATHENA
- Designates a connection used for view validation by Amazon Athena. -
NETWORK
- Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).NETWORK
Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements. -
MARKETPLACE
- Uses configuration settings contained in a connector purchased from Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by Glue.MARKETPLACE
Connections use the following ConnectionParameters.-
Required:
CONNECTOR_TYPE
,CONNECTOR_URL
,CONNECTOR_CLASS_NAME
,CONNECTION_URL
. -
Required for
JDBC
CONNECTOR_TYPE
connections: All of (USERNAME
,PASSWORD
) orSECRET_ID
.
-
-
CUSTOM
- Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by Glue.
Additionally, a
ConnectionType
for the following SaaS connectors is supported:-
FACEBOOKADS
- Designates a connection to Facebook Ads. -
GOOGLEADS
- Designates a connection to Google Ads. -
GOOGLESHEETS
- Designates a connection to Google Sheets. -
GOOGLEANALYTICS4
- Designates a connection to Google Analytics 4. -
HUBSPOT
- Designates a connection to HubSpot. -
INSTAGRAMADS
- Designates a connection to Instagram Ads. -
INTERCOM
- Designates a connection to Intercom. -
JIRACLOUD
- Designates a connection to Jira Cloud. -
MARKETO
- Designates a connection to Adobe Marketo Engage. -
NETSUITEERP
- Designates a connection to Oracle NetSuite. -
SALESFORCE
- Designates a connection to Salesforce using OAuth authentication. -
SALESFORCEMARKETINGCLOUD
- Designates a connection to Salesforce Marketing Cloud. -
SALESFORCEPARDOT
- Designates a connection to Salesforce Marketing Cloud Account Engagement (MCAE). -
SAPODATA
- Designates a connection to SAP OData. -
SERVICENOW
- Designates a connection to ServiceNow. -
SLACK
- Designates a connection to Slack. -
SNAPCHATADS
- Designates a connection to Snapchat Ads. -
STRIPE
- Designates a connection to Stripe. -
ZENDESK
- Designates a connection to Zendesk. -
ZOHOCRM
- Designates a connection to Zoho CRM.
For more information on the connection parameters needed for a particular connector, see the documentation for the connector in Adding an Glue connectionin the Glue User Guide.
SFTP
is not supported.For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties.
For more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections.
-
- See Also:
-
-
connectionTypeAsString
The type of the connection. Currently, these types are supported:
-
JDBC
- Designates a connection to a database through Java Database Connectivity (JDBC).JDBC
Connections use the following ConnectionParameters.-
Required: All of (
HOST
,PORT
,JDBC_ENGINE
) orJDBC_CONNECTION_URL
. -
Required: All of (
USERNAME
,PASSWORD
) orSECRET_ID
. -
Optional:
JDBC_ENFORCE_SSL
,CUSTOM_JDBC_CERT
,CUSTOM_JDBC_CERT_STRING
,SKIP_CUSTOM_JDBC_CERT_VALIDATION
. These parameters are used to configure SSL with JDBC.
-
-
KAFKA
- Designates a connection to an Apache Kafka streaming platform.KAFKA
Connections use the following ConnectionParameters.-
Required:
KAFKA_BOOTSTRAP_SERVERS
. -
Optional:
KAFKA_SSL_ENABLED
,KAFKA_CUSTOM_CERT
,KAFKA_SKIP_CUSTOM_CERT_VALIDATION
. These parameters are used to configure SSL withKAFKA
. -
Optional:
KAFKA_CLIENT_KEYSTORE
,KAFKA_CLIENT_KEYSTORE_PASSWORD
,KAFKA_CLIENT_KEY_PASSWORD
,ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD
,ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD
. These parameters are used to configure TLS client configuration with SSL inKAFKA
. -
Optional:
KAFKA_SASL_MECHANISM
. Can be specified asSCRAM-SHA-512
,GSSAPI
, orAWS_MSK_IAM
. -
Optional:
KAFKA_SASL_SCRAM_USERNAME
,KAFKA_SASL_SCRAM_PASSWORD
,ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD
. These parameters are used to configure SASL/SCRAM-SHA-512 authentication withKAFKA
. -
Optional:
KAFKA_SASL_GSSAPI_KEYTAB
,KAFKA_SASL_GSSAPI_KRB5_CONF
,KAFKA_SASL_GSSAPI_SERVICE
,KAFKA_SASL_GSSAPI_PRINCIPAL
. These parameters are used to configure SASL/GSSAPI authentication withKAFKA
.
-
-
MONGODB
- Designates a connection to a MongoDB document database.MONGODB
Connections use the following ConnectionParameters.-
Required:
CONNECTION_URL
. -
Required: All of (
USERNAME
,PASSWORD
) orSECRET_ID
.
-
-
VIEW_VALIDATION_REDSHIFT
- Designates a connection used for view validation by Amazon Redshift. -
VIEW_VALIDATION_ATHENA
- Designates a connection used for view validation by Amazon Athena. -
NETWORK
- Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).NETWORK
Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements. -
MARKETPLACE
- Uses configuration settings contained in a connector purchased from Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by Glue.MARKETPLACE
Connections use the following ConnectionParameters.-
Required:
CONNECTOR_TYPE
,CONNECTOR_URL
,CONNECTOR_CLASS_NAME
,CONNECTION_URL
. -
Required for
JDBC
CONNECTOR_TYPE
connections: All of (USERNAME
,PASSWORD
) orSECRET_ID
.
-
-
CUSTOM
- Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by Glue.
Additionally, a
ConnectionType
for the following SaaS connectors is supported:-
FACEBOOKADS
- Designates a connection to Facebook Ads. -
GOOGLEADS
- Designates a connection to Google Ads. -
GOOGLESHEETS
- Designates a connection to Google Sheets. -
GOOGLEANALYTICS4
- Designates a connection to Google Analytics 4. -
HUBSPOT
- Designates a connection to HubSpot. -
INSTAGRAMADS
- Designates a connection to Instagram Ads. -
INTERCOM
- Designates a connection to Intercom. -
JIRACLOUD
- Designates a connection to Jira Cloud. -
MARKETO
- Designates a connection to Adobe Marketo Engage. -
NETSUITEERP
- Designates a connection to Oracle NetSuite. -
SALESFORCE
- Designates a connection to Salesforce using OAuth authentication. -
SALESFORCEMARKETINGCLOUD
- Designates a connection to Salesforce Marketing Cloud. -
SALESFORCEPARDOT
- Designates a connection to Salesforce Marketing Cloud Account Engagement (MCAE). -
SAPODATA
- Designates a connection to SAP OData. -
SERVICENOW
- Designates a connection to ServiceNow. -
SLACK
- Designates a connection to Slack. -
SNAPCHATADS
- Designates a connection to Snapchat Ads. -
STRIPE
- Designates a connection to Stripe. -
ZENDESK
- Designates a connection to Zendesk. -
ZOHOCRM
- Designates a connection to Zoho CRM.
For more information on the connection parameters needed for a particular connector, see the documentation for the connector in Adding an Glue connectionin the Glue User Guide.
SFTP
is not supported.For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties.
For more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections.
If the service returns an enum value that is not available in the current SDK version,
connectionType
will returnConnectionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconnectionTypeAsString()
.- Returns:
- The type of the connection. Currently, these types are supported:
-
JDBC
- Designates a connection to a database through Java Database Connectivity (JDBC).JDBC
Connections use the following ConnectionParameters.-
Required: All of (
HOST
,PORT
,JDBC_ENGINE
) orJDBC_CONNECTION_URL
. -
Required: All of (
USERNAME
,PASSWORD
) orSECRET_ID
. -
Optional:
JDBC_ENFORCE_SSL
,CUSTOM_JDBC_CERT
,CUSTOM_JDBC_CERT_STRING
,SKIP_CUSTOM_JDBC_CERT_VALIDATION
. These parameters are used to configure SSL with JDBC.
-
-
KAFKA
- Designates a connection to an Apache Kafka streaming platform.KAFKA
Connections use the following ConnectionParameters.-
Required:
KAFKA_BOOTSTRAP_SERVERS
. -
Optional:
KAFKA_SSL_ENABLED
,KAFKA_CUSTOM_CERT
,KAFKA_SKIP_CUSTOM_CERT_VALIDATION
. These parameters are used to configure SSL withKAFKA
. -
Optional:
KAFKA_CLIENT_KEYSTORE
,KAFKA_CLIENT_KEYSTORE_PASSWORD
,KAFKA_CLIENT_KEY_PASSWORD
,ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD
,ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD
. These parameters are used to configure TLS client configuration with SSL inKAFKA
. -
Optional:
KAFKA_SASL_MECHANISM
. Can be specified asSCRAM-SHA-512
,GSSAPI
, orAWS_MSK_IAM
. -
Optional:
KAFKA_SASL_SCRAM_USERNAME
,KAFKA_SASL_SCRAM_PASSWORD
,ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD
. These parameters are used to configure SASL/SCRAM-SHA-512 authentication withKAFKA
. -
Optional:
KAFKA_SASL_GSSAPI_KEYTAB
,KAFKA_SASL_GSSAPI_KRB5_CONF
,KAFKA_SASL_GSSAPI_SERVICE
,KAFKA_SASL_GSSAPI_PRINCIPAL
. These parameters are used to configure SASL/GSSAPI authentication withKAFKA
.
-
-
MONGODB
- Designates a connection to a MongoDB document database.MONGODB
Connections use the following ConnectionParameters.-
Required:
CONNECTION_URL
. -
Required: All of (
USERNAME
,PASSWORD
) orSECRET_ID
.
-
-
VIEW_VALIDATION_REDSHIFT
- Designates a connection used for view validation by Amazon Redshift. -
VIEW_VALIDATION_ATHENA
- Designates a connection used for view validation by Amazon Athena. -
NETWORK
- Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).NETWORK
Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements. -
MARKETPLACE
- Uses configuration settings contained in a connector purchased from Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by Glue.MARKETPLACE
Connections use the following ConnectionParameters.-
Required:
CONNECTOR_TYPE
,CONNECTOR_URL
,CONNECTOR_CLASS_NAME
,CONNECTION_URL
. -
Required for
JDBC
CONNECTOR_TYPE
connections: All of (USERNAME
,PASSWORD
) orSECRET_ID
.
-
-
CUSTOM
- Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by Glue.
Additionally, a
ConnectionType
for the following SaaS connectors is supported:-
FACEBOOKADS
- Designates a connection to Facebook Ads. -
GOOGLEADS
- Designates a connection to Google Ads. -
GOOGLESHEETS
- Designates a connection to Google Sheets. -
GOOGLEANALYTICS4
- Designates a connection to Google Analytics 4. -
HUBSPOT
- Designates a connection to HubSpot. -
INSTAGRAMADS
- Designates a connection to Instagram Ads. -
INTERCOM
- Designates a connection to Intercom. -
JIRACLOUD
- Designates a connection to Jira Cloud. -
MARKETO
- Designates a connection to Adobe Marketo Engage. -
NETSUITEERP
- Designates a connection to Oracle NetSuite. -
SALESFORCE
- Designates a connection to Salesforce using OAuth authentication. -
SALESFORCEMARKETINGCLOUD
- Designates a connection to Salesforce Marketing Cloud. -
SALESFORCEPARDOT
- Designates a connection to Salesforce Marketing Cloud Account Engagement (MCAE). -
SAPODATA
- Designates a connection to SAP OData. -
SERVICENOW
- Designates a connection to ServiceNow. -
SLACK
- Designates a connection to Slack. -
SNAPCHATADS
- Designates a connection to Snapchat Ads. -
STRIPE
- Designates a connection to Stripe. -
ZENDESK
- Designates a connection to Zendesk. -
ZOHOCRM
- Designates a connection to Zoho CRM.
For more information on the connection parameters needed for a particular connector, see the documentation for the connector in Adding an Glue connectionin the Glue User Guide.
SFTP
is not supported.For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties.
For more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections.
-
- See Also:
-
-
hasMatchCriteria
public final boolean hasMatchCriteria()For responses, this returns true if the service returned a value for the MatchCriteria property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
matchCriteria
A list of criteria that can be used in selecting this connection.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasMatchCriteria()
method.- Returns:
- A list of criteria that can be used in selecting this connection.
-
connectionProperties
These key-value pairs define parameters for the connection.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasConnectionProperties()
method.- Returns:
- These key-value pairs define parameters for the connection.
-
hasConnectionProperties
public final boolean hasConnectionProperties()For responses, this returns true if the service returned a value for the ConnectionProperties property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
connectionPropertiesAsStrings
These key-value pairs define parameters for the connection.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasConnectionProperties()
method.- Returns:
- These key-value pairs define parameters for the connection.
-
hasSparkProperties
public final boolean hasSparkProperties()For responses, this returns true if the service returned a value for the SparkProperties property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
sparkProperties
Connection properties specific to the Spark compute environment.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSparkProperties()
method.- Returns:
- Connection properties specific to the Spark compute environment.
-
hasAthenaProperties
public final boolean hasAthenaProperties()For responses, this returns true if the service returned a value for the AthenaProperties property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
athenaProperties
Connection properties specific to the Athena compute environment.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAthenaProperties()
method.- Returns:
- Connection properties specific to the Athena compute environment.
-
hasPythonProperties
public final boolean hasPythonProperties()For responses, this returns true if the service returned a value for the PythonProperties property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
pythonProperties
Connection properties specific to the Python compute environment.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasPythonProperties()
method.- Returns:
- Connection properties specific to the Python compute environment.
-
physicalConnectionRequirements
The physical connection requirements, such as virtual private cloud (VPC) and
SecurityGroup
, that are needed to successfully make this connection.- Returns:
- The physical connection requirements, such as virtual private cloud (VPC) and
SecurityGroup
, that are needed to successfully make this connection.
-
authenticationConfiguration
The authentication properties of the connection.
- Returns:
- The authentication properties of the connection.
-
validateCredentials
A flag to validate the credentials during create connection. Default is true.
- Returns:
- A flag to validate the credentials during create connection. Default is true.
-
validateForComputeEnvironments
The compute environments that the specified connection properties are validated against.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasValidateForComputeEnvironments()
method.- Returns:
- The compute environments that the specified connection properties are validated against.
-
hasValidateForComputeEnvironments
public final boolean hasValidateForComputeEnvironments()For responses, this returns true if the service returned a value for the ValidateForComputeEnvironments property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
validateForComputeEnvironmentsAsStrings
The compute environments that the specified connection properties are validated against.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasValidateForComputeEnvironments()
method.- Returns:
- The compute environments that the specified connection properties are validated against.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ConnectionInput.Builder,
ConnectionInput> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-