ibm-cloud-sdk-core
Version:
Core functionality to support SDKs generated with IBM's OpenAPI SDK Generator.
55 lines (26 loc) • 1.36 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [VpcInstanceAuthenticator](./ibm-cloud-sdk-core.vpcinstanceauthenticator.md) > [(constructor)](./ibm-cloud-sdk-core.vpcinstanceauthenticator._constructor_.md)
## VpcInstanceAuthenticator.(constructor)
Create a new VpcInstanceAuthenticator instance.
**Signature:**
```typescript
constructor(options: Options);
```
## Parameters
<table><thead><tr><th>
Parameter
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
options
</td><td>
Options
</td><td>
Configuration options for VpcInstance authentication. This should be an object containing these fields: - url: (optional) the endpoint URL for the VPC Instance Metadata Service (default value: "http://169.254.169.254") - iamProfileCrn: (optional) the CRN of the linked IAM trusted profile to be used to obtain the IAM access token - iamProfileId: (optional) the ID of the linked IAM trusted profile to be used to obtain the IAM access token
</td></tr>
</tbody></table>
## Remarks
At most one of "iamProfileCrn" or "iamProfileId" may be specified. If neither one is specified, then the default IAM profile defined for the compute resource will be used.