class IntegrationCredentials
This page is available in another version. Click here for the v2 documentation.
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.APIGatewayv2.IntegrationCredentials |
![]() | software.amazon.awscdk.services.apigatewayv2.IntegrationCredentials |
![]() | aws_cdk.aws_apigatewayv2.IntegrationCredentials |
![]() | @aws-cdk/aws-apigatewayv2 » IntegrationCredentials |
Credentials used for AWS Service integrations.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as apigatewayv2 from '@aws-cdk/aws-apigatewayv2';
import * as iam from '@aws-cdk/aws-iam';
declare const role: iam.Role;
const integrationCredentials = apigatewayv2.IntegrationCredentials.fromRole(role);
Initializer
new IntegrationCredentials()
Properties
Name | Type | Description |
---|---|---|
credentials | string | The ARN of the credentials. |
credentialsArn
Type:
string
The ARN of the credentials.
Methods
Name | Description |
---|---|
static from | Use the specified role for integration requests. |
static use | Use the calling user's identity to call the integration. |
static fromRole(role)
public static fromRole(role: IRole): IntegrationCredentials
Parameters
- role
IRole
Returns
Use the specified role for integration requests.
static useCallerIdentity()
public static useCallerIdentity(): IntegrationCredentials
Returns
Use the calling user's identity to call the integration.