Package software.amazon.awssdk.services.appflow.model

Class CreateConnectorProfileRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.appflow.model.AppflowRequest
software.amazon.awssdk.services.appflow.model.CreateConnectorProfileRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateConnectorProfileRequest.Builder,CreateConnectorProfileRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateConnectorProfileRequest extends AppflowRequest implements ToCopyableBuilder<CreateConnectorProfileRequest.Builder,CreateConnectorProfileRequest>

  • Method Details

    • connectorProfileName

      public final String connectorProfileName()

      The name of the connector profile. The name is unique for each ConnectorProfile in your Amazon Web Services account.

      Returns:
      The name of the connector profile. The name is unique for each ConnectorProfile in your Amazon Web Services account.

    • kmsArn

      public final String kmsArn()

      The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.

      Returns:
      The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.

    • connectorType

      public final ConnectorType connectorType()

      The type of connector, such as Salesforce, Amplitude, and so on.

      If the service returns an enum value that is not available in the current SDK version, connectorType will return ConnectorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectorTypeAsString().

      Returns:
      The type of connector, such as Salesforce, Amplitude, and so on.
      See Also:

    • connectorTypeAsString

      public final String connectorTypeAsString()

      The type of connector, such as Salesforce, Amplitude, and so on.

      If the service returns an enum value that is not available in the current SDK version, connectorType will return ConnectorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectorTypeAsString().

      Returns:
      The type of connector, such as Salesforce, Amplitude, and so on.
      See Also:

    • connectorLabel

      public final String connectorLabel()

      The label of the connector. The label is unique for each ConnectorRegistration in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.

      Returns:
      The label of the connector. The label is unique for each ConnectorRegistration in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.

    • connectionMode

      public final ConnectionMode connectionMode()

      Indicates the connection mode and specifies whether it is public or private. Private flows use Amazon Web Services PrivateLink to route data over Amazon Web Services infrastructure without exposing it to the public internet.

      If the service returns an enum value that is not available in the current SDK version, connectionMode will return ConnectionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectionModeAsString().

      Returns:
      Indicates the connection mode and specifies whether it is public or private. Private flows use Amazon Web Services PrivateLink to route data over Amazon Web Services infrastructure without exposing it to the public internet.
      See Also:

    • connectionModeAsString

      public final String connectionModeAsString()

      Indicates the connection mode and specifies whether it is public or private. Private flows use Amazon Web Services PrivateLink to route data over Amazon Web Services infrastructure without exposing it to the public internet.

      If the service returns an enum value that is not available in the current SDK version, connectionMode will return ConnectionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectionModeAsString().

      Returns:
      Indicates the connection mode and specifies whether it is public or private. Private flows use Amazon Web Services PrivateLink to route data over Amazon Web Services infrastructure without exposing it to the public internet.
      See Also:

    • connectorProfileConfig

      public final ConnectorProfileConfig connectorProfileConfig()

      Defines the connector-specific configuration and credentials.

      Returns:
      Defines the connector-specific configuration and credentials.

    • clientToken

      public final String clientToken()

      The clientToken parameter is an idempotency token. It ensures that your CreateConnectorProfile request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value.

      If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.

      If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken, Amazon AppFlow considers it a new call to CreateConnectorProfile . The token is active for 8 hours.

      Returns:
      The clientToken parameter is an idempotency token. It ensures that your CreateConnectorProfile request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value.

      If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.

      If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken, Amazon AppFlow considers it a new call to CreateConnectorProfile. The token is active for 8 hours.

    • toBuilder

      public CreateConnectorProfileRequest.Builder 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 interface ToCopyableBuilder<CreateConnectorProfileRequest.Builder,CreateConnectorProfileRequest>
      Specified by:
      toBuilder in class AppflowRequest
      Returns:
      a builder for type T

    • builder

      public static CreateConnectorProfileRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateConnectorProfileRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.