| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>AwsClientProperties</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="AwsClientProperties"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.iceberg.aws</a></div> |
| <h2 title="Class AwsClientProperties" class="title">Class AwsClientProperties</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.iceberg.aws.AwsClientProperties</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>java.io.Serializable</code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">AwsClientProperties</span> |
| extends java.lang.Object |
| implements java.io.Serializable</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../serialized-form.html#org.apache.iceberg.aws.AwsClientProperties">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#CLIENT_CREDENTIAL_PROVIDER_PREFIX">CLIENT_CREDENTIAL_PROVIDER_PREFIX</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Used by the client.credentials-provider configured value that will be used by <a href="AwsClientFactories.html#defaultFactory()"><code>AwsClientFactories.defaultFactory()</code></a> and other AWS client factory |
| classes to pass provider-specific properties.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#CLIENT_CREDENTIALS_PROVIDER">CLIENT_CREDENTIALS_PROVIDER</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Configure the AWS credentials provider used to create AWS clients.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#CLIENT_REGION">CLIENT_REGION</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Used by <code>AwsClientFactories.DefaultAwsClientFactory</code> and also |
| other client factory classes.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">AwsClientProperties</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.util.Map)">AwsClientProperties</a></span>​(java.util.Map<java.lang.String,​java.lang.String> properties)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><T extends software.amazon.awssdk.awscore.client.builder.AwsClientBuilder><br>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#applyClientCredentialConfigurations(T)">applyClientCredentialConfigurations</a></span>​(T builder)</code></th> |
| <td class="colLast"> |
| <div class="block">Configure the credential provider for AWS clients.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><T extends software.amazon.awssdk.awscore.client.builder.AwsClientBuilder><br>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#applyClientRegionConfiguration(T)">applyClientRegionConfiguration</a></span>​(T builder)</code></th> |
| <td class="colLast"> |
| <div class="block">Configure a client AWS region.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clientRegion()">clientRegion</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>software.amazon.awssdk.auth.credentials.AwsCredentialsProvider</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#credentialsProvider(java.lang.String,java.lang.String,java.lang.String)">credentialsProvider</a></span>​(java.lang.String accessKeyId, |
| java.lang.String secretAccessKey, |
| java.lang.String sessionToken)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a credentials provider instance.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setClientRegion(java.lang.String)">setClientRegion</a></span>​(java.lang.String clientRegion)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="CLIENT_CREDENTIALS_PROVIDER"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CLIENT_CREDENTIALS_PROVIDER</h4> |
| <pre>public static final java.lang.String CLIENT_CREDENTIALS_PROVIDER</pre> |
| <div class="block">Configure the AWS credentials provider used to create AWS clients. A fully qualified concrete |
| class with package that implements the <code>AwsCredentialsProvider</code> interface is required. |
| |
| <p>Additionally, the implementation class must also have a create() or create(Map) method |
| implemented, which returns an instance of the class that provides aws credentials provider. |
| |
| <p>Example: |
| client.credentials-provider=software.amazon.awssdk.auth.credentials.SystemPropertyCredentialsProvider |
| |
| <p>When set, the default client factory <a href="AwsClientFactories.html#defaultFactory()"><code>AwsClientFactories.defaultFactory()</code></a> and other AWS client factory |
| classes will use this provider to get AWS credentials provided instead of reading the default |
| credential chain to get AWS access credentials.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.iceberg.aws.AwsClientProperties.CLIENT_CREDENTIALS_PROVIDER">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="CLIENT_CREDENTIAL_PROVIDER_PREFIX"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CLIENT_CREDENTIAL_PROVIDER_PREFIX</h4> |
| <pre>protected static final java.lang.String CLIENT_CREDENTIAL_PROVIDER_PREFIX</pre> |
| <div class="block">Used by the client.credentials-provider configured value that will be used by <a href="AwsClientFactories.html#defaultFactory()"><code>AwsClientFactories.defaultFactory()</code></a> and other AWS client factory |
| classes to pass provider-specific properties. Each property consists of a key name and an |
| associated value.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.iceberg.aws.AwsClientProperties.CLIENT_CREDENTIAL_PROVIDER_PREFIX">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="CLIENT_REGION"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CLIENT_REGION</h4> |
| <pre>public static final java.lang.String CLIENT_REGION</pre> |
| <div class="block">Used by <code>AwsClientFactories.DefaultAwsClientFactory</code> and also |
| other client factory classes. If set, all AWS clients except STS client will use the given |
| region instead of the default region chain.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.iceberg.aws.AwsClientProperties.CLIENT_REGION">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>AwsClientProperties</h4> |
| <pre>public AwsClientProperties()</pre> |
| </li> |
| </ul> |
| <a id="<init>(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AwsClientProperties</h4> |
| <pre>public AwsClientProperties​(java.util.Map<java.lang.String,​java.lang.String> properties)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="clientRegion()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clientRegion</h4> |
| <pre class="methodSignature">public java.lang.String clientRegion()</pre> |
| </li> |
| </ul> |
| <a id="setClientRegion(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setClientRegion</h4> |
| <pre class="methodSignature">public void setClientRegion​(java.lang.String clientRegion)</pre> |
| </li> |
| </ul> |
| <a id="applyClientRegionConfiguration(software.amazon.awssdk.awscore.client.builder.AwsClientBuilder)"> |
| <!-- --> |
| </a><a id="applyClientRegionConfiguration(T)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>applyClientRegionConfiguration</h4> |
| <pre class="methodSignature">public <T extends software.amazon.awssdk.awscore.client.builder.AwsClientBuilder> void applyClientRegionConfiguration​(T builder)</pre> |
| <div class="block">Configure a client AWS region. |
| |
| <p>Sample usage: |
| |
| <pre> |
| S3Client.builder().applyMutation(awsClientProperties::applyClientRegionConfiguration) |
| </pre></div> |
| </li> |
| </ul> |
| <a id="applyClientCredentialConfigurations(software.amazon.awssdk.awscore.client.builder.AwsClientBuilder)"> |
| <!-- --> |
| </a><a id="applyClientCredentialConfigurations(T)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>applyClientCredentialConfigurations</h4> |
| <pre class="methodSignature">public <T extends software.amazon.awssdk.awscore.client.builder.AwsClientBuilder> void applyClientCredentialConfigurations​(T builder)</pre> |
| <div class="block">Configure the credential provider for AWS clients. |
| |
| <p>Sample usage: |
| |
| <pre> |
| DynamoDbClient.builder().applyMutation(awsClientProperties::applyClientCredentialConfigurations) |
| </pre></div> |
| </li> |
| </ul> |
| <a id="credentialsProvider(java.lang.String,java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>credentialsProvider</h4> |
| <pre class="methodSignature">public software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsProvider​(java.lang.String accessKeyId, |
| java.lang.String secretAccessKey, |
| java.lang.String sessionToken)</pre> |
| <div class="block">Returns a credentials provider instance. If params were set, we return a new credentials |
| instance. If none of the params are set, we try to dynamically load the provided credentials |
| provider class. Upon loading the class, we try to invoke <code>create(Map<String, String>)</code> |
| static method. If that fails, we fall back to <code>create()</code>. If credential provider class |
| wasn't set, we fall back to default credentials provider.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>accessKeyId</code> - the AWS access key ID</dd> |
| <dd><code>secretAccessKey</code> - the AWS secret access key</dd> |
| <dd><code>sessionToken</code> - the AWS session token</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a credentials provider instance</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| </footer> |
| </body> |
| </html> |
