Interface IAM2EndpointBuilderFactory.IAM2EndpointBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- Enclosing interface:
- IAM2EndpointBuilderFactory
public static interface IAM2EndpointBuilderFactory.IAM2EndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint for the AWS Identity and Access Management (IAM)
component.
-
Method Summary
Modifier and TypeMethodDescriptionAmazon AWS Access Key.advanced()
To use a existing configured AWS IAM as client.iamClient
(software.amazon.awssdk.services.iam.IamClient iamClient) To use a existing configured AWS IAM as client.The operation to perform.operation
(org.apache.camel.component.aws2.iam.IAM2Operations operation) The operation to perform.overrideEndpoint
(boolean overrideEndpoint) Set the need for overidding the endpoint.overrideEndpoint
(String overrideEndpoint) Set the need for overidding the endpoint.pojoRequest
(boolean pojoRequest) If we want to use a POJO request as body or not.pojoRequest
(String pojoRequest) If we want to use a POJO request as body or not.profileCredentialsName
(String profileCredentialsName) If using a profile credentials provider this parameter will set the profile name.To define a proxy host when instantiating the IAM client.To define a proxy port when instantiating the IAM client.To define a proxy port when instantiating the IAM client.proxyProtocol
(String proxyProtocol) To define a proxy protocol when instantiating the IAM client.proxyProtocol
(software.amazon.awssdk.core.Protocol proxyProtocol) To define a proxy protocol when instantiating the IAM client.The region in which IAM client needs to work.Amazon AWS Secret Key.trustAllCertificates
(boolean trustAllCertificates) If we want to trust all certificates in case of overriding the endpoint.trustAllCertificates
(String trustAllCertificates) If we want to trust all certificates in case of overriding the endpoint.uriEndpointOverride
(String uriEndpointOverride) Set the overriding uri endpoint.useDefaultCredentialsProvider
(boolean useDefaultCredentialsProvider) Set whether the IAM client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.useDefaultCredentialsProvider
(String useDefaultCredentialsProvider) Set whether the IAM client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.useProfileCredentialsProvider
(boolean useProfileCredentialsProvider) Set whether the IAM client should expect to load credentials through a profile credentials provider.useProfileCredentialsProvider
(String useProfileCredentialsProvider) Set whether the IAM client should expect to load credentials through a profile credentials provider.Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointProducerResolver
resolve, resolve
-
Method Details
-
advanced
-
iamClient
default IAM2EndpointBuilderFactory.IAM2EndpointBuilder iamClient(software.amazon.awssdk.services.iam.IamClient iamClient) To use a existing configured AWS IAM as client. The option is a: <code>software.amazon.awssdk.services.iam.IamClient</code> type. Group: producer- Parameters:
iamClient
- the value to set- Returns:
- the dsl builder
-
iamClient
To use a existing configured AWS IAM as client. The option will be converted to a <code>software.amazon.awssdk.services.iam.IamClient</code> type. Group: producer- Parameters:
iamClient
- the value to set- Returns:
- the dsl builder
-
operation
default IAM2EndpointBuilderFactory.IAM2EndpointBuilder operation(org.apache.camel.component.aws2.iam.IAM2Operations operation) The operation to perform. You can configure a default operation on the component level, or the operation as part of the endpoint, or via a message header with the key CamelAwsIAMOperation. The option is a: <code>org.apache.camel.component.aws2.iam.IAM2Operations</code> type. Group: producer- Parameters:
operation
- the value to set- Returns:
- the dsl builder
-
operation
The operation to perform. You can configure a default operation on the component level, or the operation as part of the endpoint, or via a message header with the key CamelAwsIAMOperation. The option will be converted to a <code>org.apache.camel.component.aws2.iam.IAM2Operations</code> type. Group: producer- Parameters:
operation
- the value to set- Returns:
- the dsl builder
-
overrideEndpoint
Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option. The option is a: <code>boolean</code> type. Default: false Group: producer- Parameters:
overrideEndpoint
- the value to set- Returns:
- the dsl builder
-
overrideEndpoint
Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option. The option will be converted to a <code>boolean</code> type. Default: false Group: producer- Parameters:
overrideEndpoint
- the value to set- Returns:
- the dsl builder
-
pojoRequest
If we want to use a POJO request as body or not. The option is a: <code>boolean</code> type. Default: false Group: producer- Parameters:
pojoRequest
- the value to set- Returns:
- the dsl builder
-
pojoRequest
If we want to use a POJO request as body or not. The option will be converted to a <code>boolean</code> type. Default: false Group: producer- Parameters:
pojoRequest
- the value to set- Returns:
- the dsl builder
-
region
The region in which IAM client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id(). The option is a: <code>java.lang.String</code> type. Default: aws-global Group: producer- Parameters:
region
- the value to set- Returns:
- the dsl builder
-
uriEndpointOverride
default IAM2EndpointBuilderFactory.IAM2EndpointBuilder uriEndpointOverride(String uriEndpointOverride) Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
uriEndpointOverride
- the value to set- Returns:
- the dsl builder
-
proxyHost
To define a proxy host when instantiating the IAM client. The option is a: <code>java.lang.String</code> type. Group: proxy- Parameters:
proxyHost
- the value to set- Returns:
- the dsl builder
-
proxyPort
To define a proxy port when instantiating the IAM client. The option is a: <code>java.lang.Integer</code> type. Group: proxy- Parameters:
proxyPort
- the value to set- Returns:
- the dsl builder
-
proxyPort
To define a proxy port when instantiating the IAM client. The option will be converted to a <code>java.lang.Integer</code> type. Group: proxy- Parameters:
proxyPort
- the value to set- Returns:
- the dsl builder
-
proxyProtocol
default IAM2EndpointBuilderFactory.IAM2EndpointBuilder proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol) To define a proxy protocol when instantiating the IAM client. The option is a: <code>software.amazon.awssdk.core.Protocol</code> type. Default: HTTPS Group: proxy- Parameters:
proxyProtocol
- the value to set- Returns:
- the dsl builder
-
proxyProtocol
To define a proxy protocol when instantiating the IAM client. The option will be converted to a <code>software.amazon.awssdk.core.Protocol</code> type. Default: HTTPS Group: proxy- Parameters:
proxyProtocol
- the value to set- Returns:
- the dsl builder
-
accessKey
Amazon AWS Access Key. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
accessKey
- the value to set- Returns:
- the dsl builder
-
profileCredentialsName
default IAM2EndpointBuilderFactory.IAM2EndpointBuilder profileCredentialsName(String profileCredentialsName) If using a profile credentials provider this parameter will set the profile name. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
profileCredentialsName
- the value to set- Returns:
- the dsl builder
-
secretKey
Amazon AWS Secret Key. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
secretKey
- the value to set- Returns:
- the dsl builder
-
trustAllCertificates
default IAM2EndpointBuilderFactory.IAM2EndpointBuilder trustAllCertificates(boolean trustAllCertificates) If we want to trust all certificates in case of overriding the endpoint. The option is a: <code>boolean</code> type. Default: false Group: security- Parameters:
trustAllCertificates
- the value to set- Returns:
- the dsl builder
-
trustAllCertificates
default IAM2EndpointBuilderFactory.IAM2EndpointBuilder trustAllCertificates(String trustAllCertificates) If we want to trust all certificates in case of overriding the endpoint. The option will be converted to a <code>boolean</code> type. Default: false Group: security- Parameters:
trustAllCertificates
- the value to set- Returns:
- the dsl builder
-
useDefaultCredentialsProvider
default IAM2EndpointBuilderFactory.IAM2EndpointBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider) Set whether the IAM client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. The option is a: <code>boolean</code> type. Default: false Group: security- Parameters:
useDefaultCredentialsProvider
- the value to set- Returns:
- the dsl builder
-
useDefaultCredentialsProvider
default IAM2EndpointBuilderFactory.IAM2EndpointBuilder useDefaultCredentialsProvider(String useDefaultCredentialsProvider) Set whether the IAM client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. The option will be converted to a <code>boolean</code> type. Default: false Group: security- Parameters:
useDefaultCredentialsProvider
- the value to set- Returns:
- the dsl builder
-
useProfileCredentialsProvider
default IAM2EndpointBuilderFactory.IAM2EndpointBuilder useProfileCredentialsProvider(boolean useProfileCredentialsProvider) Set whether the IAM client should expect to load credentials through a profile credentials provider. The option is a: <code>boolean</code> type. Default: false Group: security- Parameters:
useProfileCredentialsProvider
- the value to set- Returns:
- the dsl builder
-
useProfileCredentialsProvider
default IAM2EndpointBuilderFactory.IAM2EndpointBuilder useProfileCredentialsProvider(String useProfileCredentialsProvider) Set whether the IAM client should expect to load credentials through a profile credentials provider. The option will be converted to a <code>boolean</code> type. Default: false Group: security- Parameters:
useProfileCredentialsProvider
- the value to set- Returns:
- the dsl builder
-