Interface CreateConnectorProfileRequest.Builder

All Superinterfaces:
AppflowRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<CreateConnectorProfileRequest.Builder,CreateConnectorProfileRequest>, SdkBuilder<CreateConnectorProfileRequest.Builder,CreateConnectorProfileRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateConnectorProfileRequest
public static interface CreateConnectorProfileRequest.Builder extends AppflowRequest.Builder, SdkPojo, CopyableBuilder<CreateConnectorProfileRequest.Builder,CreateConnectorProfileRequest>

  • Method Details

    • connectorProfileName

      CreateConnectorProfileRequest.Builder connectorProfileName(String connectorProfileName)

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

      Parameters:
      connectorProfileName - The name of the connector profile. The name is unique for each ConnectorProfile in your Amazon Web Services account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsArn

      CreateConnectorProfileRequest.Builder kmsArn(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • connectorType

      CreateConnectorProfileRequest.Builder connectorType(String connectorType)

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

      Parameters:
      connectorType - The type of connector, such as Salesforce, Amplitude, and so on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • connectorType

      CreateConnectorProfileRequest.Builder connectorType(ConnectorType connectorType)

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

      Parameters:
      connectorType - The type of connector, such as Salesforce, Amplitude, and so on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • connectorLabel

      CreateConnectorProfileRequest.Builder connectorLabel(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/.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • connectionMode

      CreateConnectorProfileRequest.Builder connectionMode(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • connectionMode

      CreateConnectorProfileRequest.Builder connectionMode(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • connectorProfileConfig

      CreateConnectorProfileRequest.Builder connectorProfileConfig(ConnectorProfileConfig connectorProfileConfig)

      Defines the connector-specific configuration and credentials.

      Parameters:
      connectorProfileConfig - Defines the connector-specific configuration and credentials.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • connectorProfileConfig

      default CreateConnectorProfileRequest.Builder connectorProfileConfig(Consumer<ConnectorProfileConfig.Builder> connectorProfileConfig)

      Defines the connector-specific configuration and credentials.

      This is a convenience method that creates an instance of the ConnectorProfileConfig.Builder avoiding the need to create one manually via ConnectorProfileConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to connectorProfileConfig(ConnectorProfileConfig).

      Parameters:
      connectorProfileConfig - a consumer that will call methods on ConnectorProfileConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientToken

      CreateConnectorProfileRequest.Builder clientToken(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateConnectorProfileRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateConnectorProfileRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.