Interface CreateConnectorProfileRequest.Builder
- All Superinterfaces:
AppflowRequest.Builder
,AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateConnectorProfileRequest.Builder,
,CreateConnectorProfileRequest> SdkBuilder<CreateConnectorProfileRequest.Builder,
,CreateConnectorProfileRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateConnectorProfileRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientToken
(String clientToken) TheclientToken
parameter is an idempotency token.connectionMode
(String connectionMode) Indicates the connection mode and specifies whether it is public or private.connectionMode
(ConnectionMode connectionMode) Indicates the connection mode and specifies whether it is public or private.connectorLabel
(String connectorLabel) The label of the connector.connectorProfileConfig
(Consumer<ConnectorProfileConfig.Builder> connectorProfileConfig) Defines the connector-specific configuration and credentials.connectorProfileConfig
(ConnectorProfileConfig connectorProfileConfig) Defines the connector-specific configuration and credentials.connectorProfileName
(String connectorProfileName) The name of the connector profile.connectorType
(String connectorType) The type of connector, such as Salesforce, Amplitude, and so on.connectorType
(ConnectorType connectorType) The type of connector, such as Salesforce, Amplitude, and so on.The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Methods inherited from interface software.amazon.awssdk.services.appflow.model.AppflowRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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 eachConnectorProfile
in your Amazon Web Services account.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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
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 eachConnectorRegistration
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
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
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 theConnectorProfileConfig.Builder
avoiding the need to create one manually viaConnectorProfileConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toconnectorProfileConfig(ConnectorProfileConfig)
.- Parameters:
connectorProfileConfig
- a consumer that will call methods onConnectorProfileConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
clientToken
The
clientToken
parameter is an idempotency token. It ensures that yourCreateConnectorProfile
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 sameclientToken
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 toCreateConnectorProfile
. The token is active for 8 hours.- Parameters:
clientToken
- TheclientToken
parameter is an idempotency token. It ensures that yourCreateConnectorProfile
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 sameclientToken
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 toCreateConnectorProfile
. 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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-