| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>AwsOptions (Apache Beam 2.38.0-SNAPSHOT)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="AwsOptions (Apache Beam 2.38.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.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"> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/aws2/options/AwsModule.html" title="class in org.apache.beam.sdk.io.aws2.options"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/aws2/options/AwsOptions.AwsRegionFactory.html" title="class in org.apache.beam.sdk.io.aws2.options"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/aws2/options/AwsOptions.html" target="_top">Frames</a></li> |
| <li><a href="AwsOptions.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.beam.sdk.io.aws2.options</div> |
| <h2 title="Interface AwsOptions" class="title">Interface AwsOptions</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a>, <a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../../../../org/apache/beam/sdk/io/aws2/options/S3Options.html" title="interface in org.apache.beam.sdk.io.aws2.options">S3Options</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre><a href="../../../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>(<a href="../../../../../../../org/apache/beam/sdk/annotations/Experimental.html#value--">value</a>=<a href="../../../../../../../org/apache/beam/sdk/annotations/Experimental.Kind.html#SOURCE_SINK">SOURCE_SINK</a>) |
| public interface <span class="typeNameLabel">AwsOptions</span> |
| extends <a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a></pre> |
| <div class="block">Options used to configure Amazon Web Services specific options such as credentials and region.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/options/AwsOptions.AwsRegionFactory.html" title="class in org.apache.beam.sdk.io.aws2.options">AwsOptions.AwsRegionFactory</a></span></code> |
| <div class="block">Attempt to load default region.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/options/AwsOptions.AwsUserCredentialsFactory.html" title="class in org.apache.beam.sdk.io.aws2.options">AwsOptions.AwsUserCredentialsFactory</a></span></code> |
| <div class="block">Return <a href="https://static.javadoc.io/software.amazon.awssdk/auth/2.17.127/software/amazon/awssdk/auth/credentials/DefaultCredentialsProvider.html?is-external=true" title="class or interface in software.amazon.awssdk.auth.credentials"><code>DefaultCredentialsProvider</code></a> as default provider.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.beam.sdk.options.PipelineOptions"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.beam.sdk.options.<a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a></h3> |
| <code><a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.AtomicLongFactory.html" title="class in org.apache.beam.sdk.options">PipelineOptions.AtomicLongFactory</a>, <a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.CheckEnabled.html" title="enum in org.apache.beam.sdk.options">PipelineOptions.CheckEnabled</a>, <a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.DirectRunner.html" title="class in org.apache.beam.sdk.options">PipelineOptions.DirectRunner</a>, <a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.JobNameFactory.html" title="class in org.apache.beam.sdk.options">PipelineOptions.JobNameFactory</a>, <a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.UserAgentFactory.html" title="class in org.apache.beam.sdk.options">PipelineOptions.UserAgentFactory</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="https://static.javadoc.io/software.amazon.awssdk/auth/2.17.127/software/amazon/awssdk/auth/credentials/AwsCredentialsProvider.html?is-external=true" title="class or interface in software.amazon.awssdk.auth.credentials">AwsCredentialsProvider</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/options/AwsOptions.html#getAwsCredentialsProvider--">getAwsCredentialsProvider</a></span>()</code> |
| <div class="block"><a href="https://static.javadoc.io/software.amazon.awssdk/auth/2.17.127/software/amazon/awssdk/auth/credentials/AwsCredentialsProvider.html?is-external=true" title="class or interface in software.amazon.awssdk.auth.credentials"><code>AwsCredentialsProvider</code></a> used to configure AWS service clients.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://static.javadoc.io/software.amazon.awssdk/regions/2.17.127/software/amazon/awssdk/regions/Region.html?is-external=true" title="class or interface in software.amazon.awssdk.regions">Region</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/options/AwsOptions.html#getAwsRegion--">getAwsRegion</a></span>()</code> |
| <div class="block">Region used to configure AWS service clients.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/ClientBuilderFactory.html" title="interface in org.apache.beam.sdk.io.aws2.common">ClientBuilderFactory</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/options/AwsOptions.html#getClientBuilderFactory--">getClientBuilderFactory</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.net.URI</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/options/AwsOptions.html#getEndpoint--">getEndpoint</a></span>()</code> |
| <div class="block">Endpoint used to configure AWS service clients.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/HttpClientConfiguration.html" title="class in org.apache.beam.sdk.io.aws2.common">HttpClientConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/options/AwsOptions.html#getHttpClientConfiguration--">getHttpClientConfiguration</a></span>()</code> |
| <div class="block"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/HttpClientConfiguration.html" title="class in org.apache.beam.sdk.io.aws2.common"><code>HttpClientConfiguration</code></a> used to configure AWS service clients.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>software.amazon.awssdk.http.apache.ProxyConfiguration</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/options/AwsOptions.html#getProxyConfiguration--">getProxyConfiguration</a></span>()</code> |
| <div class="block"><code>ProxyConfiguration</code> used to configure AWS service clients.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/options/AwsOptions.html#setAwsCredentialsProvider-software.amazon.awssdk.auth.credentials.AwsCredentialsProvider-">setAwsCredentialsProvider</a></span>(<a href="https://static.javadoc.io/software.amazon.awssdk/auth/2.17.127/software/amazon/awssdk/auth/credentials/AwsCredentialsProvider.html?is-external=true" title="class or interface in software.amazon.awssdk.auth.credentials">AwsCredentialsProvider</a> value)</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/options/AwsOptions.html#setAwsRegion-software.amazon.awssdk.regions.Region-">setAwsRegion</a></span>(<a href="https://static.javadoc.io/software.amazon.awssdk/regions/2.17.127/software/amazon/awssdk/regions/Region.html?is-external=true" title="class or interface in software.amazon.awssdk.regions">Region</a> region)</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/options/AwsOptions.html#setClientBuilderFactory-java.lang.Class-">setClientBuilderFactory</a></span>(java.lang.Class<? extends <a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/ClientBuilderFactory.html" title="interface in org.apache.beam.sdk.io.aws2.common">ClientBuilderFactory</a>> clazz)</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/options/AwsOptions.html#setEndpoint-java.net.URI-">setEndpoint</a></span>(java.net.URI uri)</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/options/AwsOptions.html#setHttpClientConfiguration-org.apache.beam.sdk.io.aws2.common.HttpClientConfiguration-">setHttpClientConfiguration</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/HttpClientConfiguration.html" title="class in org.apache.beam.sdk.io.aws2.common">HttpClientConfiguration</a> value)</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/options/AwsOptions.html#setProxyConfiguration-software.amazon.awssdk.http.apache.ProxyConfiguration-">setProxyConfiguration</a></span>(software.amazon.awssdk.http.apache.ProxyConfiguration value)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.options.PipelineOptions"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.beam.sdk.options.<a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a></h3> |
| <code><a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#as-java.lang.Class-">as</a>, <a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#getJobName--">getJobName</a>, <a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#getOptionsId--">getOptionsId</a>, <a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#getRunner--">getRunner</a>, <a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#getStableUniqueNames--">getStableUniqueNames</a>, <a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#getTempLocation--">getTempLocation</a>, <a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#getUserAgent--">getUserAgent</a>, <a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#outputRuntimeOptions--">outputRuntimeOptions</a>, <a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#setJobName-java.lang.String-">setJobName</a>, <a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#setOptionsId-long-">setOptionsId</a>, <a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#setRunner-java.lang.Class-">setRunner</a>, <a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#setStableUniqueNames-org.apache.beam.sdk.options.PipelineOptions.CheckEnabled-">setStableUniqueNames</a>, <a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#setTempLocation-java.lang.String-">setTempLocation</a>, <a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#setUserAgent-java.lang.String-">setUserAgent</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.transforms.display.HasDisplayData"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.beam.sdk.transforms.display.<a href="../../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></h3> |
| <code><a href="../../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getAwsRegion--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAwsRegion</h4> |
| <pre><a href="../../../../../../../org/apache/beam/sdk/options/Default.InstanceFactory.html" title="annotation in org.apache.beam.sdk.options">@Default.InstanceFactory</a>(<a href="../../../../../../../org/apache/beam/sdk/options/Default.InstanceFactory.html#value--">value</a>=<a href="../../../../../../../org/apache/beam/sdk/io/aws2/options/AwsOptions.AwsRegionFactory.html" title="class in org.apache.beam.sdk.io.aws2.options">AwsOptions.AwsRegionFactory.class</a>) |
| <a href="https://static.javadoc.io/software.amazon.awssdk/regions/2.17.127/software/amazon/awssdk/regions/Region.html?is-external=true" title="class or interface in software.amazon.awssdk.regions">Region</a> getAwsRegion()</pre> |
| <div class="block">Region used to configure AWS service clients.</div> |
| </li> |
| </ul> |
| <a name="setAwsRegion-software.amazon.awssdk.regions.Region-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAwsRegion</h4> |
| <pre>void setAwsRegion(<a href="https://static.javadoc.io/software.amazon.awssdk/regions/2.17.127/software/amazon/awssdk/regions/Region.html?is-external=true" title="class or interface in software.amazon.awssdk.regions">Region</a> region)</pre> |
| </li> |
| </ul> |
| <a name="getEndpoint--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEndpoint</h4> |
| <pre>java.net.URI getEndpoint()</pre> |
| <div class="block">Endpoint used to configure AWS service clients.</div> |
| </li> |
| </ul> |
| <a name="setEndpoint-java.net.URI-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEndpoint</h4> |
| <pre>void setEndpoint(java.net.URI uri)</pre> |
| </li> |
| </ul> |
| <a name="getAwsCredentialsProvider--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAwsCredentialsProvider</h4> |
| <pre><a href="../../../../../../../org/apache/beam/sdk/options/Default.InstanceFactory.html" title="annotation in org.apache.beam.sdk.options">@Default.InstanceFactory</a>(<a href="../../../../../../../org/apache/beam/sdk/options/Default.InstanceFactory.html#value--">value</a>=<a href="../../../../../../../org/apache/beam/sdk/io/aws2/options/AwsOptions.AwsUserCredentialsFactory.html" title="class in org.apache.beam.sdk.io.aws2.options">AwsOptions.AwsUserCredentialsFactory.class</a>) |
| <a href="https://static.javadoc.io/software.amazon.awssdk/auth/2.17.127/software/amazon/awssdk/auth/credentials/AwsCredentialsProvider.html?is-external=true" title="class or interface in software.amazon.awssdk.auth.credentials">AwsCredentialsProvider</a> getAwsCredentialsProvider()</pre> |
| <div class="block"><a href="https://static.javadoc.io/software.amazon.awssdk/auth/2.17.127/software/amazon/awssdk/auth/credentials/AwsCredentialsProvider.html?is-external=true" title="class or interface in software.amazon.awssdk.auth.credentials"><code>AwsCredentialsProvider</code></a> used to configure AWS service clients. |
| |
| <p>The class name of the provider must be set in the <code>@type</code> field. Note: Not all |
| available providers are supported and some configuration options might be ignored. |
| |
| <p>Most providers rely on system's environment to follow AWS conventions, there's no further |
| configuration: |
| <li><a href="https://static.javadoc.io/software.amazon.awssdk/auth/2.17.127/software/amazon/awssdk/auth/credentials/DefaultCredentialsProvider.html?is-external=true" title="class or interface in software.amazon.awssdk.auth.credentials"><code>DefaultCredentialsProvider</code></a> |
| <li><a href="https://static.javadoc.io/software.amazon.awssdk/auth/2.17.127/software/amazon/awssdk/auth/credentials/EnvironmentVariableCredentialsProvider.html?is-external=true" title="class or interface in software.amazon.awssdk.auth.credentials"><code>EnvironmentVariableCredentialsProvider</code></a> |
| <li><a href="https://static.javadoc.io/software.amazon.awssdk/auth/2.17.127/software/amazon/awssdk/auth/credentials/SystemPropertyCredentialsProvider.html?is-external=true" title="class or interface in software.amazon.awssdk.auth.credentials"><code>SystemPropertyCredentialsProvider</code></a> |
| <li><a href="https://static.javadoc.io/software.amazon.awssdk/auth/2.17.127/software/amazon/awssdk/auth/credentials/ProfileCredentialsProvider.html?is-external=true" title="class or interface in software.amazon.awssdk.auth.credentials"><code>ProfileCredentialsProvider</code></a> |
| <li><a href="https://static.javadoc.io/software.amazon.awssdk/auth/2.17.127/software/amazon/awssdk/auth/credentials/ContainerCredentialsProvider.html?is-external=true" title="class or interface in software.amazon.awssdk.auth.credentials"><code>ContainerCredentialsProvider</code></a> |
| |
| <p>Example: |
| |
| <pre><code> --awsCredentialsProvider={"@type": "ProfileCredentialsProvider"}</code></pre> |
| |
| <p>Some other providers require additional configuration: |
| <li><a href="https://static.javadoc.io/software.amazon.awssdk/auth/2.17.127/software/amazon/awssdk/auth/credentials/StaticCredentialsProvider.html?is-external=true" title="class or interface in software.amazon.awssdk.auth.credentials"><code>StaticCredentialsProvider</code></a> |
| <li><a href="https://static.javadoc.io/software.amazon.awssdk/sts/2.17.127/software/amazon/awssdk/services/sts/auth/StsAssumeRoleCredentialsProvider.html?is-external=true" title="class or interface in software.amazon.awssdk.services.sts.auth"><code>StsAssumeRoleCredentialsProvider</code></a> |
| |
| <p>Examples: |
| |
| <pre><code> --awsCredentialsProvider={ |
| "@type": "StaticCredentialsProvider", |
| "awsAccessKeyId": "key_id_value", |
| "awsSecretKey": "secret_value" |
| } |
| |
| --awsCredentialsProvider={ |
| "@type": "StaticCredentialsProvider", |
| "awsAccessKeyId": "key_id_value", |
| "awsSecretKey": "secret_value", |
| "sessionToken": "token_value" |
| } |
| |
| --awsCredentialsProvider={ |
| "@type": "StsAssumeRoleCredentialsProvider", |
| "roleArn": "role_arn_Value", |
| "roleSessionName": "session_name_value", |
| "policy": "policy_value", |
| "durationSeconds": 3600 |
| }</code></pre></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://static.javadoc.io/software.amazon.awssdk/auth/2.17.127/software/amazon/awssdk/auth/credentials/DefaultCredentialsProvider.html?is-external=true" title="class or interface in software.amazon.awssdk.auth.credentials"><code>DefaultCredentialsProvider</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAwsCredentialsProvider-software.amazon.awssdk.auth.credentials.AwsCredentialsProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAwsCredentialsProvider</h4> |
| <pre>void setAwsCredentialsProvider(<a href="https://static.javadoc.io/software.amazon.awssdk/auth/2.17.127/software/amazon/awssdk/auth/credentials/AwsCredentialsProvider.html?is-external=true" title="class or interface in software.amazon.awssdk.auth.credentials">AwsCredentialsProvider</a> value)</pre> |
| </li> |
| </ul> |
| <a name="getProxyConfiguration--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProxyConfiguration</h4> |
| <pre>software.amazon.awssdk.http.apache.ProxyConfiguration getProxyConfiguration()</pre> |
| <div class="block"><code>ProxyConfiguration</code> used to configure AWS service clients. |
| |
| <p>Note, only the options shown in the example below are supported. <code>username</code> and |
| <code>password</code> are optional. |
| |
| <p>Example: |
| |
| <pre><code> --proxyConfiguration={ |
| "endpoint": "http://hostname:port", |
| "username": "username", |
| "password": "password" |
| }</code></pre></div> |
| </li> |
| </ul> |
| <a name="setProxyConfiguration-software.amazon.awssdk.http.apache.ProxyConfiguration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProxyConfiguration</h4> |
| <pre>void setProxyConfiguration(software.amazon.awssdk.http.apache.ProxyConfiguration value)</pre> |
| </li> |
| </ul> |
| <a name="getHttpClientConfiguration--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHttpClientConfiguration</h4> |
| <pre><a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/HttpClientConfiguration.html" title="class in org.apache.beam.sdk.io.aws2.common">HttpClientConfiguration</a> getHttpClientConfiguration()</pre> |
| <div class="block"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/HttpClientConfiguration.html" title="class in org.apache.beam.sdk.io.aws2.common"><code>HttpClientConfiguration</code></a> used to configure AWS service clients. |
| |
| <p>Example: |
| |
| <pre><code> --httpClientConfiguration={"socketTimeout":1000, "maxConnections":10}</code></pre></div> |
| </li> |
| </ul> |
| <a name="setHttpClientConfiguration-org.apache.beam.sdk.io.aws2.common.HttpClientConfiguration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHttpClientConfiguration</h4> |
| <pre>void setHttpClientConfiguration(<a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/HttpClientConfiguration.html" title="class in org.apache.beam.sdk.io.aws2.common">HttpClientConfiguration</a> value)</pre> |
| </li> |
| </ul> |
| <a name="getClientBuilderFactory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClientBuilderFactory</h4> |
| <pre><a href="../../../../../../../org/apache/beam/sdk/options/Default.Class.html" title="annotation in org.apache.beam.sdk.options">@Default.Class</a>(<a href="../../../../../../../org/apache/beam/sdk/options/Default.Class.html#value--">value</a>=<a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/ClientBuilderFactory.DefaultClientBuilder.html" title="class in org.apache.beam.sdk.io.aws2.common">ClientBuilderFactory.DefaultClientBuilder.class</a>) |
| java.lang.Class<? extends <a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/ClientBuilderFactory.html" title="interface in org.apache.beam.sdk.io.aws2.common">ClientBuilderFactory</a>> getClientBuilderFactory()</pre> |
| </li> |
| </ul> |
| <a name="setClientBuilderFactory-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setClientBuilderFactory</h4> |
| <pre>void setClientBuilderFactory(java.lang.Class<? extends <a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/ClientBuilderFactory.html" title="interface in org.apache.beam.sdk.io.aws2.common">ClientBuilderFactory</a>> clazz)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.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"> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/aws2/options/AwsModule.html" title="class in org.apache.beam.sdk.io.aws2.options"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/aws2/options/AwsOptions.AwsRegionFactory.html" title="class in org.apache.beam.sdk.io.aws2.options"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/aws2/options/AwsOptions.html" target="_top">Frames</a></li> |
| <li><a href="AwsOptions.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../allclasses-noframe.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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |