Package software.amazon.awscdk.services.iot

Interface CfnAuthorizerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAuthorizerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-11T15:56:00.151Z")
@Stability(Stable)
public interface CfnAuthorizerProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAuthorizer.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iot.*;
 CfnAuthorizerProps cfnAuthorizerProps = CfnAuthorizerProps.builder()
         .authorizerFunctionArn("authorizerFunctionArn")
         // the properties below are optional
         .authorizerName("authorizerName")
         .enableCachingForHttp(false)
         .signingDisabled(false)
         .status("status")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .tokenKeyName("tokenKeyName")
         .tokenSigningPublicKeys(Map.of(
                 "tokenSigningPublicKeysKey", "tokenSigningPublicKeys"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAuthorizerProps.Builder	A builder for CfnAuthorizerProps
static final class	CfnAuthorizerProps.Jsii$Proxy	An implementation for CfnAuthorizerProps

Method Summary

Modifier and Type	Method	Description
static CfnAuthorizerProps.Builder	builder()
String	getAuthorizerFunctionArn()	The authorizer's Lambda function ARN.
default String	getAuthorizerName()	The authorizer name.
default Object	getEnableCachingForHttp()	When true , the result from the authorizer's Lambda function is cached for clients that use persistent HTTP connections.
default Object	getSigningDisabled()	Specifies whether AWS IoT validates the token signature in an authorization request.
default String	getStatus()	The status of the authorizer.
default List<CfnTag>	getTags()	Metadata which can be used to manage the custom authorizer.
default String	getTokenKeyName()	The key used to extract the token from the HTTP headers.
default Object	getTokenSigningPublicKeys()	The public keys used to validate the token signature returned by your custom authentication service.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthorizerFunctionArn

@Stability(Stable)
@NotNull
String getAuthorizerFunctionArn()

The authorizer's Lambda function ARN.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-authorizerfunctionarn

getAuthorizerName

@Stability(Stable)
@Nullable
default String getAuthorizerName()

The authorizer name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-authorizername

getEnableCachingForHttp

@Stability(Stable)
@Nullable
default Object getEnableCachingForHttp()

When true , the result from the authorizer's Lambda function is cached for clients that use persistent HTTP connections.

The results are cached for the time specified by the Lambda function in refreshAfterInSeconds . This value doesn't affect authorization of clients that use MQTT connections.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-enablecachingforhttp

getSigningDisabled

@Stability(Stable)
@Nullable
default Object getSigningDisabled()

Specifies whether AWS IoT validates the token signature in an authorization request.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-signingdisabled

getStatus

@Stability(Stable)
@Nullable
default String getStatus()

The status of the authorizer.

Valid values: ACTIVE | INACTIVE

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-status

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Metadata which can be used to manage the custom authorizer.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-tags

getTokenKeyName

@Stability(Stable)
@Nullable
default String getTokenKeyName()

The key used to extract the token from the HTTP headers.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-tokenkeyname

getTokenSigningPublicKeys

@Stability(Stable)
@Nullable
default Object getTokenSigningPublicKeys()

The public keys used to validate the token signature returned by your custom authentication service.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-tokensigningpublickeys

builder

@Stability(Stable)
static CfnAuthorizerProps.Builder builder()

Returns:

a CfnAuthorizerProps.Builder of CfnAuthorizerProps