This is an automated email from the ASF dual-hosted git repository. acosentino pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/camel.git
commit 9b1a6be017553e6dce5799c2a87d762e5918f8d4 Author: Andrea Cosentino <anco...@gmail.com> AuthorDate: Fri Nov 20 08:43:58 2020 +0100 CAMEL-15843 - Camel-AWS2: Rename useIamCredentials to useDefaultCredentialProvider where it is used, regen --- .../camel/catalog/docs/aws2-s3-component.adoc | 4 +- .../aws2/s3/AWS2S3ComponentConfigurer.java | 12 ++-- .../aws2/s3/AWS2S3EndpointConfigurer.java | 12 ++-- .../aws2/s3/AWS2S3EndpointUriFactory.java | 2 +- .../apache/camel/component/aws2/s3/aws2-s3.json | 4 +- .../src/main/docs/aws2-s3-component.adoc | 4 +- .../component/aws2/s3/AWS2S3Configuration.java | 4 +- .../dsl/Aws2S3ComponentBuilderFactory.java | 13 +++-- .../endpoint/dsl/AWS2S3EndpointBuilderFactory.java | 65 ++++++++++++---------- .../modules/ROOT/pages/aws2-s3-component.adoc | 4 +- 10 files changed, 66 insertions(+), 58 deletions(-) diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws2-s3-component.adoc b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws2-s3-component.adoc index a94d3cc..c61d8fc 100644 --- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws2-s3-component.adoc +++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws2-s3-component.adoc @@ -67,7 +67,7 @@ The AWS 2 S3 Storage Service component supports 42 options, which are listed bel | *region* (common) | The region in which S3 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() | | String | *trustAllCertificates* (common) | If we want to trust all certificates in case of overriding the endpoint | false | boolean | *uriEndpointOverride* (common) | Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option | | String -| *useIAMCredentials* (common) | Set whether the S3 client should expect to load credentials on an EC2 instance or to expect static credentials to be passed in. | false | boolean +| *useDefaultCredentialsProvider* (common) | Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. | false | boolean | *customerAlgorithm* (common) | Define the customer algorithm to use in case CustomerKey is enabled | | String | *customerKeyId* (common) | Define the id of Customer key to use in case CustomerKey is enabled | | String | *customerKeyMD5* (common) | Define the MD5 of Customer key to use in case CustomerKey is enabled | | String @@ -146,7 +146,7 @@ with the following path and query parameters: | *region* (common) | The region in which S3 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() | | String | *trustAllCertificates* (common) | If we want to trust all certificates in case of overriding the endpoint | false | boolean | *uriEndpointOverride* (common) | Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option | | String -| *useIAMCredentials* (common) | Set whether the S3 client should expect to load credentials on an EC2 instance or to expect static credentials to be passed in. | false | boolean +| *useDefaultCredentialsProvider* (common) | Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. | false | boolean | *customerAlgorithm* (common) | Define the customer algorithm to use in case CustomerKey is enabled | | String | *customerKeyId* (common) | Define the id of Customer key to use in case CustomerKey is enabled | | String | *customerKeyMD5* (common) | Define the MD5 of Customer key to use in case CustomerKey is enabled | | String diff --git a/components/camel-aws2-s3/src/generated/java/org/apache/camel/component/aws2/s3/AWS2S3ComponentConfigurer.java b/components/camel-aws2-s3/src/generated/java/org/apache/camel/component/aws2/s3/AWS2S3ComponentConfigurer.java index 2852bd5..f00cc8c 100644 --- a/components/camel-aws2-s3/src/generated/java/org/apache/camel/component/aws2/s3/AWS2S3ComponentConfigurer.java +++ b/components/camel-aws2-s3/src/generated/java/org/apache/camel/component/aws2/s3/AWS2S3ComponentConfigurer.java @@ -104,8 +104,8 @@ public class AWS2S3ComponentConfigurer extends PropertyConfigurerSupport impleme case "useAwsKMS": getOrCreateConfiguration(target).setUseAwsKMS(property(camelContext, boolean.class, value)); return true; case "usecustomerkey": case "useCustomerKey": getOrCreateConfiguration(target).setUseCustomerKey(property(camelContext, boolean.class, value)); return true; - case "useiamcredentials": - case "useIAMCredentials": getOrCreateConfiguration(target).setUseIAMCredentials(property(camelContext, boolean.class, value)); return true; + case "usedefaultcredentialsprovider": + case "useDefaultCredentialsProvider": getOrCreateConfiguration(target).setUseDefaultCredentialsProvider(property(camelContext, boolean.class, value)); return true; default: return false; } } @@ -194,8 +194,8 @@ public class AWS2S3ComponentConfigurer extends PropertyConfigurerSupport impleme case "useAwsKMS": return boolean.class; case "usecustomerkey": case "useCustomerKey": return boolean.class; - case "useiamcredentials": - case "useIAMCredentials": return boolean.class; + case "usedefaultcredentialsprovider": + case "useDefaultCredentialsProvider": return boolean.class; default: return null; } } @@ -280,8 +280,8 @@ public class AWS2S3ComponentConfigurer extends PropertyConfigurerSupport impleme case "useAwsKMS": return getOrCreateConfiguration(target).isUseAwsKMS(); case "usecustomerkey": case "useCustomerKey": return getOrCreateConfiguration(target).isUseCustomerKey(); - case "useiamcredentials": - case "useIAMCredentials": return getOrCreateConfiguration(target).isUseIAMCredentials(); + case "usedefaultcredentialsprovider": + case "useDefaultCredentialsProvider": return getOrCreateConfiguration(target).isUseDefaultCredentialsProvider(); default: return null; } } diff --git a/components/camel-aws2-s3/src/generated/java/org/apache/camel/component/aws2/s3/AWS2S3EndpointConfigurer.java b/components/camel-aws2-s3/src/generated/java/org/apache/camel/component/aws2/s3/AWS2S3EndpointConfigurer.java index eca7a1e..e7c6840 100644 --- a/components/camel-aws2-s3/src/generated/java/org/apache/camel/component/aws2/s3/AWS2S3EndpointConfigurer.java +++ b/components/camel-aws2-s3/src/generated/java/org/apache/camel/component/aws2/s3/AWS2S3EndpointConfigurer.java @@ -130,10 +130,10 @@ public class AWS2S3EndpointConfigurer extends PropertyConfigurerSupport implemen case "useAwsKMS": target.getConfiguration().setUseAwsKMS(property(camelContext, boolean.class, value)); return true; case "usecustomerkey": case "useCustomerKey": target.getConfiguration().setUseCustomerKey(property(camelContext, boolean.class, value)); return true; + case "usedefaultcredentialsprovider": + case "useDefaultCredentialsProvider": target.getConfiguration().setUseDefaultCredentialsProvider(property(camelContext, boolean.class, value)); return true; case "usefixeddelay": case "useFixedDelay": target.setUseFixedDelay(property(camelContext, boolean.class, value)); return true; - case "useiamcredentials": - case "useIAMCredentials": target.getConfiguration().setUseIAMCredentials(property(camelContext, boolean.class, value)); return true; default: return false; } } @@ -255,10 +255,10 @@ public class AWS2S3EndpointConfigurer extends PropertyConfigurerSupport implemen case "useAwsKMS": return boolean.class; case "usecustomerkey": case "useCustomerKey": return boolean.class; + case "usedefaultcredentialsprovider": + case "useDefaultCredentialsProvider": return boolean.class; case "usefixeddelay": case "useFixedDelay": return boolean.class; - case "useiamcredentials": - case "useIAMCredentials": return boolean.class; default: return null; } } @@ -376,10 +376,10 @@ public class AWS2S3EndpointConfigurer extends PropertyConfigurerSupport implemen case "useAwsKMS": return target.getConfiguration().isUseAwsKMS(); case "usecustomerkey": case "useCustomerKey": return target.getConfiguration().isUseCustomerKey(); + case "usedefaultcredentialsprovider": + case "useDefaultCredentialsProvider": return target.getConfiguration().isUseDefaultCredentialsProvider(); case "usefixeddelay": case "useFixedDelay": return target.isUseFixedDelay(); - case "useiamcredentials": - case "useIAMCredentials": return target.getConfiguration().isUseIAMCredentials(); default: return null; } } diff --git a/components/camel-aws2-s3/src/generated/java/org/apache/camel/component/aws2/s3/AWS2S3EndpointUriFactory.java b/components/camel-aws2-s3/src/generated/java/org/apache/camel/component/aws2/s3/AWS2S3EndpointUriFactory.java index 963515f..d15123b 100644 --- a/components/camel-aws2-s3/src/generated/java/org/apache/camel/component/aws2/s3/AWS2S3EndpointUriFactory.java +++ b/components/camel-aws2-s3/src/generated/java/org/apache/camel/component/aws2/s3/AWS2S3EndpointUriFactory.java @@ -21,7 +21,6 @@ public class AWS2S3EndpointUriFactory extends org.apache.camel.support.component private static final Set<String> SECRET_PROPERTY_NAMES; static { Set<String> props = new HashSet<>(62); - props.add("useIAMCredentials"); props.add("customerAlgorithm"); props.add("fileName"); props.add("useCustomerKey"); @@ -77,6 +76,7 @@ public class AWS2S3EndpointUriFactory extends org.apache.camel.support.component props.add("exchangePattern"); props.add("keyName"); props.add("includeFolders"); + props.add("useDefaultCredentialsProvider"); props.add("destinationBucketPrefix"); props.add("autocloseBody"); props.add("pollStrategy"); diff --git a/components/camel-aws2-s3/src/generated/resources/org/apache/camel/component/aws2/s3/aws2-s3.json b/components/camel-aws2-s3/src/generated/resources/org/apache/camel/component/aws2/s3/aws2-s3.json index 7b4beba..e318fcf 100644 --- a/components/camel-aws2-s3/src/generated/resources/org/apache/camel/component/aws2/s3/aws2-s3.json +++ b/components/camel-aws2-s3/src/generated/resources/org/apache/camel/component/aws2/s3/aws2-s3.json @@ -35,7 +35,7 @@ "region": { "kind": "property", "displayName": "Region", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.s3.AWS2S3Configuration", "configurationField": "configuration", "description": "The region in which S3 client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (f [...] "trustAllCertificates": { "kind": "property", "displayName": "Trust All Certificates", "group": "common", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws2.s3.AWS2S3Configuration", "configurationField": "configuration", "description": "If we want to trust all certificates in case of overriding the endpoint" }, "uriEndpointOverride": { "kind": "property", "displayName": "Uri Endpoint Override", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.s3.AWS2S3Configuration", "configurationField": "configuration", "description": "Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option" }, - "useIAMCredentials": { "kind": "property", "displayName": "Use IAMCredentials", "group": "common", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws2.s3.AWS2S3Configuration", "configurationField": "configuration", "description": "Set whether the S3 client should expect to load credentials on an EC2 instance or to expect static [...] + "useDefaultCredentialsProvider": { "kind": "property", "displayName": "Use Default Credentials Provider", "group": "common", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws2.s3.AWS2S3Configuration", "configurationField": "configuration", "description": "Set whether the S3 client should expect to load credentials through a def [...] "customerAlgorithm": { "kind": "property", "displayName": "Customer Algorithm", "group": "common (advanced)", "label": "common,advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.s3.AWS2S3Configuration", "configurationField": "configuration", "description": "Define the customer algorithm to use in case CustomerKey is enabled" }, "customerKeyId": { "kind": "property", "displayName": "Customer Key Id", "group": "common (advanced)", "label": "common,advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.s3.AWS2S3Configuration", "configurationField": "configuration", "description": "Define the id of Customer key to use in case CustomerKey is enabled" }, "customerKeyMD5": { "kind": "property", "displayName": "Customer Key MD5", "group": "common (advanced)", "label": "common,advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.s3.AWS2S3Configuration", "configurationField": "configuration", "description": "Define the MD5 of Customer key to use in case CustomerKey is enabled" }, @@ -79,7 +79,7 @@ "region": { "kind": "parameter", "displayName": "Region", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.s3.AWS2S3Configuration", "configurationField": "configuration", "description": "The region in which S3 client needs to work. When using this parameter, the configuration will expect the lowercase name of the region ( [...] "trustAllCertificates": { "kind": "parameter", "displayName": "Trust All Certificates", "group": "common", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws2.s3.AWS2S3Configuration", "configurationField": "configuration", "description": "If we want to trust all certificates in case of overriding the endpoint" }, "uriEndpointOverride": { "kind": "parameter", "displayName": "Uri Endpoint Override", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.s3.AWS2S3Configuration", "configurationField": "configuration", "description": "Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option" }, - "useIAMCredentials": { "kind": "parameter", "displayName": "Use IAMCredentials", "group": "common", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws2.s3.AWS2S3Configuration", "configurationField": "configuration", "description": "Set whether the S3 client should expect to load credentials on an EC2 instance or to expect static [...] + "useDefaultCredentialsProvider": { "kind": "parameter", "displayName": "Use Default Credentials Provider", "group": "common", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws2.s3.AWS2S3Configuration", "configurationField": "configuration", "description": "Set whether the S3 client should expect to load credentials through a de [...] "customerAlgorithm": { "kind": "parameter", "displayName": "Customer Algorithm", "group": "common (advanced)", "label": "common,advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.s3.AWS2S3Configuration", "configurationField": "configuration", "description": "Define the customer algorithm to use in case CustomerKey is enabled" }, "customerKeyId": { "kind": "parameter", "displayName": "Customer Key Id", "group": "common (advanced)", "label": "common,advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.s3.AWS2S3Configuration", "configurationField": "configuration", "description": "Define the id of Customer key to use in case CustomerKey is enabled" }, "customerKeyMD5": { "kind": "parameter", "displayName": "Customer Key MD5", "group": "common (advanced)", "label": "common,advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.s3.AWS2S3Configuration", "configurationField": "configuration", "description": "Define the MD5 of Customer key to use in case CustomerKey is enabled" }, diff --git a/components/camel-aws2-s3/src/main/docs/aws2-s3-component.adoc b/components/camel-aws2-s3/src/main/docs/aws2-s3-component.adoc index a94d3cc..c61d8fc 100644 --- a/components/camel-aws2-s3/src/main/docs/aws2-s3-component.adoc +++ b/components/camel-aws2-s3/src/main/docs/aws2-s3-component.adoc @@ -67,7 +67,7 @@ The AWS 2 S3 Storage Service component supports 42 options, which are listed bel | *region* (common) | The region in which S3 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() | | String | *trustAllCertificates* (common) | If we want to trust all certificates in case of overriding the endpoint | false | boolean | *uriEndpointOverride* (common) | Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option | | String -| *useIAMCredentials* (common) | Set whether the S3 client should expect to load credentials on an EC2 instance or to expect static credentials to be passed in. | false | boolean +| *useDefaultCredentialsProvider* (common) | Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. | false | boolean | *customerAlgorithm* (common) | Define the customer algorithm to use in case CustomerKey is enabled | | String | *customerKeyId* (common) | Define the id of Customer key to use in case CustomerKey is enabled | | String | *customerKeyMD5* (common) | Define the MD5 of Customer key to use in case CustomerKey is enabled | | String @@ -146,7 +146,7 @@ with the following path and query parameters: | *region* (common) | The region in which S3 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() | | String | *trustAllCertificates* (common) | If we want to trust all certificates in case of overriding the endpoint | false | boolean | *uriEndpointOverride* (common) | Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option | | String -| *useIAMCredentials* (common) | Set whether the S3 client should expect to load credentials on an EC2 instance or to expect static credentials to be passed in. | false | boolean +| *useDefaultCredentialsProvider* (common) | Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. | false | boolean | *customerAlgorithm* (common) | Define the customer algorithm to use in case CustomerKey is enabled | | String | *customerKeyId* (common) | Define the id of Customer key to use in case CustomerKey is enabled | | String | *customerKeyMD5* (common) | Define the MD5 of Customer key to use in case CustomerKey is enabled | | String diff --git a/components/camel-aws2-s3/src/main/java/org/apache/camel/component/aws2/s3/AWS2S3Configuration.java b/components/camel-aws2-s3/src/main/java/org/apache/camel/component/aws2/s3/AWS2S3Configuration.java index 43fc515..9e70d51 100644 --- a/components/camel-aws2-s3/src/main/java/org/apache/camel/component/aws2/s3/AWS2S3Configuration.java +++ b/components/camel-aws2-s3/src/main/java/org/apache/camel/component/aws2/s3/AWS2S3Configuration.java @@ -472,8 +472,8 @@ public class AWS2S3Configuration implements Cloneable { } /** - * Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to - * be passed in. + * Set whether the S3 client should expect to load credentials through a default credentials provider or to expect + * static credentials to be passed in. */ public void setUseDefaultCredentialsProvider(Boolean useDefaultCredentialsProvider) { this.useDefaultCredentialsProvider = useDefaultCredentialsProvider; diff --git a/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/Aws2S3ComponentBuilderFactory.java b/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/Aws2S3ComponentBuilderFactory.java index 2e32378..1c22ef1 100644 --- a/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/Aws2S3ComponentBuilderFactory.java +++ b/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/Aws2S3ComponentBuilderFactory.java @@ -221,17 +221,18 @@ public interface Aws2S3ComponentBuilderFactory { return this; } /** - * Set whether the S3 client should expect to load credentials on an EC2 - * instance or to expect static credentials to be passed in. + * Set whether the S3 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: common */ - default Aws2S3ComponentBuilder useIAMCredentials( - boolean useIAMCredentials) { - doSetProperty("useIAMCredentials", useIAMCredentials); + default Aws2S3ComponentBuilder useDefaultCredentialsProvider( + boolean useDefaultCredentialsProvider) { + doSetProperty("useDefaultCredentialsProvider", useDefaultCredentialsProvider); return this; } /** @@ -661,7 +662,7 @@ public interface Aws2S3ComponentBuilderFactory { case "region": getOrCreateConfiguration((AWS2S3Component) component).setRegion((java.lang.String) value); return true; case "trustAllCertificates": getOrCreateConfiguration((AWS2S3Component) component).setTrustAllCertificates((boolean) value); return true; case "uriEndpointOverride": getOrCreateConfiguration((AWS2S3Component) component).setUriEndpointOverride((java.lang.String) value); return true; - case "useIAMCredentials": getOrCreateConfiguration((AWS2S3Component) component).setUseIAMCredentials((boolean) value); return true; + case "useDefaultCredentialsProvider": getOrCreateConfiguration((AWS2S3Component) component).setUseDefaultCredentialsProvider((boolean) value); return true; case "customerAlgorithm": getOrCreateConfiguration((AWS2S3Component) component).setCustomerAlgorithm((java.lang.String) value); return true; case "customerKeyId": getOrCreateConfiguration((AWS2S3Component) component).setCustomerKeyId((java.lang.String) value); return true; case "customerKeyMD5": getOrCreateConfiguration((AWS2S3Component) component).setCustomerKeyMD5((java.lang.String) value); return true; diff --git a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/AWS2S3EndpointBuilderFactory.java b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/AWS2S3EndpointBuilderFactory.java index 50d4b5c..78e7eac 100644 --- a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/AWS2S3EndpointBuilderFactory.java +++ b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/AWS2S3EndpointBuilderFactory.java @@ -315,31 +315,33 @@ public interface AWS2S3EndpointBuilderFactory { return this; } /** - * Set whether the S3 client should expect to load credentials on an EC2 - * instance or to expect static credentials to be passed in. + * Set whether the S3 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: common */ - default AWS2S3EndpointConsumerBuilder useIAMCredentials( - boolean useIAMCredentials) { - doSetProperty("useIAMCredentials", useIAMCredentials); + default AWS2S3EndpointConsumerBuilder useDefaultCredentialsProvider( + boolean useDefaultCredentialsProvider) { + doSetProperty("useDefaultCredentialsProvider", useDefaultCredentialsProvider); return this; } /** - * Set whether the S3 client should expect to load credentials on an EC2 - * instance or to expect static credentials to be passed in. + * Set whether the S3 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: common */ - default AWS2S3EndpointConsumerBuilder useIAMCredentials( - String useIAMCredentials) { - doSetProperty("useIAMCredentials", useIAMCredentials); + default AWS2S3EndpointConsumerBuilder useDefaultCredentialsProvider( + String useDefaultCredentialsProvider) { + doSetProperty("useDefaultCredentialsProvider", useDefaultCredentialsProvider); return this; } /** @@ -1573,31 +1575,33 @@ public interface AWS2S3EndpointBuilderFactory { return this; } /** - * Set whether the S3 client should expect to load credentials on an EC2 - * instance or to expect static credentials to be passed in. + * Set whether the S3 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: common */ - default AWS2S3EndpointProducerBuilder useIAMCredentials( - boolean useIAMCredentials) { - doSetProperty("useIAMCredentials", useIAMCredentials); + default AWS2S3EndpointProducerBuilder useDefaultCredentialsProvider( + boolean useDefaultCredentialsProvider) { + doSetProperty("useDefaultCredentialsProvider", useDefaultCredentialsProvider); return this; } /** - * Set whether the S3 client should expect to load credentials on an EC2 - * instance or to expect static credentials to be passed in. + * Set whether the S3 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: common */ - default AWS2S3EndpointProducerBuilder useIAMCredentials( - String useIAMCredentials) { - doSetProperty("useIAMCredentials", useIAMCredentials); + default AWS2S3EndpointProducerBuilder useDefaultCredentialsProvider( + String useDefaultCredentialsProvider) { + doSetProperty("useDefaultCredentialsProvider", useDefaultCredentialsProvider); return this; } /** @@ -2204,30 +2208,33 @@ public interface AWS2S3EndpointBuilderFactory { return this; } /** - * Set whether the S3 client should expect to load credentials on an EC2 - * instance or to expect static credentials to be passed in. + * Set whether the S3 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: common */ - default AWS2S3EndpointBuilder useIAMCredentials( - boolean useIAMCredentials) { - doSetProperty("useIAMCredentials", useIAMCredentials); + default AWS2S3EndpointBuilder useDefaultCredentialsProvider( + boolean useDefaultCredentialsProvider) { + doSetProperty("useDefaultCredentialsProvider", useDefaultCredentialsProvider); return this; } /** - * Set whether the S3 client should expect to load credentials on an EC2 - * instance or to expect static credentials to be passed in. + * Set whether the S3 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: common */ - default AWS2S3EndpointBuilder useIAMCredentials(String useIAMCredentials) { - doSetProperty("useIAMCredentials", useIAMCredentials); + default AWS2S3EndpointBuilder useDefaultCredentialsProvider( + String useDefaultCredentialsProvider) { + doSetProperty("useDefaultCredentialsProvider", useDefaultCredentialsProvider); return this; } /** diff --git a/docs/components/modules/ROOT/pages/aws2-s3-component.adoc b/docs/components/modules/ROOT/pages/aws2-s3-component.adoc index b2e0809..986458a 100644 --- a/docs/components/modules/ROOT/pages/aws2-s3-component.adoc +++ b/docs/components/modules/ROOT/pages/aws2-s3-component.adoc @@ -69,7 +69,7 @@ The AWS 2 S3 Storage Service component supports 42 options, which are listed bel | *region* (common) | The region in which S3 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() | | String | *trustAllCertificates* (common) | If we want to trust all certificates in case of overriding the endpoint | false | boolean | *uriEndpointOverride* (common) | Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option | | String -| *useIAMCredentials* (common) | Set whether the S3 client should expect to load credentials on an EC2 instance or to expect static credentials to be passed in. | false | boolean +| *useDefaultCredentialsProvider* (common) | Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. | false | boolean | *customerAlgorithm* (common) | Define the customer algorithm to use in case CustomerKey is enabled | | String | *customerKeyId* (common) | Define the id of Customer key to use in case CustomerKey is enabled | | String | *customerKeyMD5* (common) | Define the MD5 of Customer key to use in case CustomerKey is enabled | | String @@ -148,7 +148,7 @@ with the following path and query parameters: | *region* (common) | The region in which S3 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() | | String | *trustAllCertificates* (common) | If we want to trust all certificates in case of overriding the endpoint | false | boolean | *uriEndpointOverride* (common) | Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option | | String -| *useIAMCredentials* (common) | Set whether the S3 client should expect to load credentials on an EC2 instance or to expect static credentials to be passed in. | false | boolean +| *useDefaultCredentialsProvider* (common) | Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. | false | boolean | *customerAlgorithm* (common) | Define the customer algorithm to use in case CustomerKey is enabled | | String | *customerKeyId* (common) | Define the id of Customer key to use in case CustomerKey is enabled | | String | *customerKeyMD5* (common) | Define the MD5 of Customer key to use in case CustomerKey is enabled | | String