RequestContext.Jsii$Proxy (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.amazon.awscdk.services.apigateway.RequestContext.Jsii$Proxy

All Implemented Interfaces:: RequestContext, software.amazon.jsii.JsiiSerializable

Enclosing interface:: RequestContext

@Stability(value=Stable)
 @Internal
public static final class RequestContext.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements RequestContext

An implementation for RequestContext

Nested Class Summary
- Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
  software.amazon.jsii.JsiiObject.InitializationMode
- Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.RequestContext
  RequestContext.Builder, RequestContext.Jsii$Proxy

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)` Constructor that initializes the object based on values retrieved from the JsiiObject.
`protected`	`Jsii$Proxy(RequestContext.Builder builder)` Constructor that initializes the object based on literal property values passed by the `RequestContext.Builder`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.fasterxml.jackson.databind.JsonNode`	`$jsii$toJson()`
`boolean`	`equals(Object o)`
`Boolean`	`getAccountId()` Represents the information of $context.identity.accountId.
`Boolean`	`getApiId()` Represents the information of $context.apiId.
`Boolean`	`getApiKey()` Represents the information of $context.identity.apiKey.
`Boolean`	`getAuthorizerPrincipalId()` Represents the information of $context.authorizer.principalId.
`Boolean`	`getCaller()` Represents the information of $context.identity.caller.
`Boolean`	`getCognitoAuthenticationProvider()` Represents the information of $context.identity.cognitoAuthenticationProvider.
`Boolean`	`getCognitoAuthenticationType()` Represents the information of $context.identity.cognitoAuthenticationType.
`Boolean`	`getCognitoIdentityId()` Represents the information of $context.identity.cognitoIdentityId.
`Boolean`	`getCognitoIdentityPoolId()` Represents the information of $context.identity.cognitoIdentityPoolId.
`Boolean`	`getHttpMethod()` Represents the information of $context.httpMethod.
`Boolean`	`getRequestId()` Represents the information of $context.requestId.
`Boolean`	`getResourceId()` Represents the information of $context.resourceId.
`Boolean`	`getResourcePath()` Represents the information of $context.resourcePath.
`Boolean`	`getSourceIp()` Represents the information of $context.identity.sourceIp.
`Boolean`	`getStage()` Represents the information of $context.stage.
`Boolean`	`getUser()` Represents the information of $context.identity.user.
`Boolean`	`getUserAgent()` Represents the information of $context.identity.userAgent.
`Boolean`	`getUserArn()` Represents the information of $context.identity.userArn.
`int`	`hashCode()`

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.services.apigateway.RequestContext
builder

- Constructor Detail
  - Jsii$Proxy
```
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
```
    Constructor that initializes the object based on values retrieved from the JsiiObject.
    
    Parameters:
    
    objRef - Reference to the JSII managed object.
  - Jsii$Proxy
```
protected Jsii$Proxy(RequestContext.Builder builder)
```
    Constructor that initializes the object based on literal property values passed by the RequestContext.Builder.
- Method Detail
  - getAccountId
```
public final Boolean getAccountId()
```
    Description copied from interface: RequestContext
    
    Represents the information of $context.identity.accountId.
    Whether the AWS account of the API owner should be included in the request context
    Default: false
    
    Specified by:
    
    getAccountId in interface RequestContext
  - getApiId
```
public final Boolean getApiId()
```
    Description copied from interface: RequestContext
    
    Represents the information of $context.apiId.
    Whether the identifier API Gateway assigns to your API should be included in the request context.
    Default: false
    
    Specified by:
    
    getApiId in interface RequestContext
  - getApiKey
```
public final Boolean getApiKey()
```
    Description copied from interface: RequestContext
    
    Represents the information of $context.identity.apiKey.
    Whether the API key associated with the request should be included in request context.
    Default: false
    
    Specified by:
    
    getApiKey in interface RequestContext
  - getAuthorizerPrincipalId
```
public final Boolean getAuthorizerPrincipalId()
```
    Description copied from interface: RequestContext
    
    Represents the information of $context.authorizer.principalId.
    Whether the principal user identifier associated with the token sent by the client and returned from an API Gateway Lambda authorizer should be included in the request context.
    Default: false
    
    Specified by:
    
    getAuthorizerPrincipalId in interface RequestContext
  - getCaller
```
public final Boolean getCaller()
```
    Description copied from interface: RequestContext
    
    Represents the information of $context.identity.caller.
    Whether the principal identifier of the caller that signed the request should be included in the request context. Supported for resources that use IAM authorization.
    Default: false
    
    Specified by:
    
    getCaller in interface RequestContext
  - getCognitoAuthenticationProvider
```
public final Boolean getCognitoAuthenticationProvider()
```
    Description copied from interface: RequestContext
    
    Represents the information of $context.identity.cognitoAuthenticationProvider.
    Whether the list of the Amazon Cognito authentication providers used by the caller making the request should be included in the request context. Available only if the request was signed with Amazon Cognito credentials.
    Default: false
    
    Specified by:
    
    getCognitoAuthenticationProvider in interface RequestContext
  - getCognitoAuthenticationType
```
public final Boolean getCognitoAuthenticationType()
```
    Description copied from interface: RequestContext
    
    Represents the information of $context.identity.cognitoAuthenticationType.
    Whether the Amazon Cognito authentication type of the caller making the request should be included in the request context. Available only if the request was signed with Amazon Cognito credentials. Possible values include authenticated for authenticated identities and unauthenticated for unauthenticated identities.
    Default: false
    
    Specified by:
    
    getCognitoAuthenticationType in interface RequestContext
  - getCognitoIdentityId
```
public final Boolean getCognitoIdentityId()
```
    Description copied from interface: RequestContext
    
    Represents the information of $context.identity.cognitoIdentityId.
    Whether the Amazon Cognito identity ID of the caller making the request should be included in the request context. Available only if the request was signed with Amazon Cognito credentials.
    Default: false
    
    Specified by:
    
    getCognitoIdentityId in interface RequestContext
  - getCognitoIdentityPoolId
```
public final Boolean getCognitoIdentityPoolId()
```
    Description copied from interface: RequestContext
    
    Represents the information of $context.identity.cognitoIdentityPoolId.
    Whether the Amazon Cognito identity pool ID of the caller making the request should be included in the request context. Available only if the request was signed with Amazon Cognito credentials.
    Default: false
    
    Specified by:
    
    getCognitoIdentityPoolId in interface RequestContext
  - getHttpMethod
```
public final Boolean getHttpMethod()
```
    Description copied from interface: RequestContext
    
    Represents the information of $context.httpMethod.
    Whether the HTTP method used should be included in the request context. Valid values include: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.
    Default: false
    
    Specified by:
    
    getHttpMethod in interface RequestContext
  - getRequestId
```
public final Boolean getRequestId()
```
    Description copied from interface: RequestContext
    
    Represents the information of $context.requestId.
    Whether the ID for the request should be included in the request context.
    Default: false
    
    Specified by:
    
    getRequestId in interface RequestContext
  - getResourceId
```
public final Boolean getResourceId()
```
    Description copied from interface: RequestContext
    
    Represents the information of $context.resourceId.
    Whether the identifier that API Gateway assigns to your resource should be included in the request context.
    Default: false
    
    Specified by:
    
    getResourceId in interface RequestContext
  - getResourcePath
```
public final Boolean getResourcePath()
```
    Description copied from interface: RequestContext
    
    Represents the information of $context.resourcePath.
    Whether the path to the resource should be included in the request context.
    Default: false
    
    Specified by:
    
    getResourcePath in interface RequestContext
  - getSourceIp
```
public final Boolean getSourceIp()
```
    Description copied from interface: RequestContext
    
    Represents the information of $context.identity.sourceIp.
    Whether the source IP address of the immediate TCP connection making the request to API Gateway endpoint should be included in the request context.
    Default: false
    
    Specified by:
    
    getSourceIp in interface RequestContext
  - getStage
```
public final Boolean getStage()
```
    Description copied from interface: RequestContext
    
    Represents the information of $context.stage.
    Whether the deployment stage of the API request should be included in the request context.
    Default: false
    
    Specified by:
    
    getStage in interface RequestContext
  - getUser
```
public final Boolean getUser()
```
    Description copied from interface: RequestContext
    
    Represents the information of $context.identity.user.
    Whether the principal identifier of the user that will be authorized should be included in the request context. Supported for resources that use IAM authorization.
    Default: false
    
    Specified by:
    
    getUser in interface RequestContext
  - getUserAgent
```
public final Boolean getUserAgent()
```
    Description copied from interface: RequestContext
    
    Represents the information of $context.identity.userAgent.
    Whether the User-Agent header of the API caller should be included in the request context.
    Default: false
    
    Specified by:
    
    getUserAgent in interface RequestContext
  - getUserArn
```
public final Boolean getUserArn()
```
    Description copied from interface: RequestContext
    
    Represents the information of $context.identity.userArn.
    Whether the Amazon Resource Name (ARN) of the effective user identified after authentication should be included in the request context.
    Default: false
    
    Specified by:
    
    getUserArn in interface RequestContext
  - $jsii$toJson
```
@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
```
    Specified by:
    
    $jsii$toJson in interface software.amazon.jsii.JsiiSerializable
  - equals
```
public final boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class RequestContext.Jsii$Proxy

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.RequestContext

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awscdk.services.apigateway.RequestContext

Constructor Detail

Jsii$Proxy

Jsii$Proxy

Method Detail

getAccountId

getApiId

getApiKey

getAuthorizerPrincipalId

getCaller

getCognitoAuthenticationProvider

getCognitoAuthenticationType

getCognitoIdentityId

getCognitoIdentityPoolId

getHttpMethod

getRequestId

getResourceId

getResourcePath

getSourceIp

getStage

getUser

getUserAgent

getUserArn

$jsii$toJson

equals

hashCode