Package software.amazon.awscdk.services.iot

Class CfnAuthorizer.Builder

java.lang.Object

software.amazon.awscdk.services.iot.CfnAuthorizer.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAuthorizer>

Enclosing class:

CfnAuthorizer

@Stability(Stable)
public static final class CfnAuthorizer.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAuthorizer>

A fluent builder for CfnAuthorizer.

Method Summary

Modifier and Type	Method	Description
CfnAuthorizer.Builder	authorizerFunctionArn(String authorizerFunctionArn)	The authorizer's Lambda function ARN.
CfnAuthorizer.Builder	authorizerName(String authorizerName)	The authorizer name.
CfnAuthorizer	build()
static CfnAuthorizer.Builder	create(software.constructs.Construct scope, String id)
CfnAuthorizer.Builder	enableCachingForHttp(Boolean enableCachingForHttp)	When true , the result from the authorizer's Lambda function is cached for clients that use persistent HTTP connections.
CfnAuthorizer.Builder	enableCachingForHttp(IResolvable enableCachingForHttp)	When true , the result from the authorizer's Lambda function is cached for clients that use persistent HTTP connections.
CfnAuthorizer.Builder	signingDisabled(Boolean signingDisabled)	Specifies whether AWS IoT validates the token signature in an authorization request.
CfnAuthorizer.Builder	signingDisabled(IResolvable signingDisabled)	Specifies whether AWS IoT validates the token signature in an authorization request.
CfnAuthorizer.Builder	status(String status)	The status of the authorizer.
CfnAuthorizer.Builder	tags(List<? extends CfnTag> tags)	Metadata which can be used to manage the custom authorizer.
CfnAuthorizer.Builder	tokenKeyName(String tokenKeyName)	The key used to extract the token from the HTTP headers.
CfnAuthorizer.Builder	tokenSigningPublicKeys(Map<String,String> tokenSigningPublicKeys)	The public keys used to validate the token signature returned by your custom authentication service.
CfnAuthorizer.Builder	tokenSigningPublicKeys(IResolvable tokenSigningPublicKeys)	The public keys used to validate the token signature returned by your custom authentication service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnAuthorizer.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnAuthorizer.Builder.

authorizerFunctionArn

@Stability(Stable)
public CfnAuthorizer.Builder authorizerFunctionArn(String authorizerFunctionArn)

The authorizer's Lambda function ARN.

Parameters:

authorizerFunctionArn - The authorizer's Lambda function ARN. This parameter is required.

Returns:

this

See Also:

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

authorizerName

@Stability(Stable)
public CfnAuthorizer.Builder authorizerName(String authorizerName)

The authorizer name.

Parameters:

authorizerName - The authorizer name. This parameter is required.

Returns:

this

See Also:

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

enableCachingForHttp

@Stability(Stable)
public CfnAuthorizer.Builder enableCachingForHttp(Boolean enableCachingForHttp)

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.

Parameters:

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

Returns:

this

See Also:

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

enableCachingForHttp

@Stability(Stable)
public CfnAuthorizer.Builder enableCachingForHttp(IResolvable enableCachingForHttp)

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.

Parameters:

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

Returns:

this

See Also:

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

signingDisabled

@Stability(Stable)
public CfnAuthorizer.Builder signingDisabled(Boolean signingDisabled)

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

Parameters:

signingDisabled - Specifies whether AWS IoT validates the token signature in an authorization request. This parameter is required.

Returns:

this

See Also:

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

signingDisabled

@Stability(Stable)
public CfnAuthorizer.Builder signingDisabled(IResolvable signingDisabled)

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

Parameters:

signingDisabled - Specifies whether AWS IoT validates the token signature in an authorization request. This parameter is required.

Returns:

this

See Also:

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

status

@Stability(Stable)
public CfnAuthorizer.Builder status(String status)

The status of the authorizer.

Valid values: ACTIVE | INACTIVE

Parameters:

status - The status of the authorizer. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnAuthorizer.Builder tags(List<? extends CfnTag> tags)

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..."

Parameters:

tags - Metadata which can be used to manage the custom authorizer. This parameter is required.

Returns:

this

See Also:

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

tokenKeyName

@Stability(Stable)
public CfnAuthorizer.Builder tokenKeyName(String tokenKeyName)

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

Parameters:

tokenKeyName - The key used to extract the token from the HTTP headers. This parameter is required.

Returns:

this

See Also:

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

tokenSigningPublicKeys

@Stability(Stable)
public CfnAuthorizer.Builder tokenSigningPublicKeys(IResolvable tokenSigningPublicKeys)

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

Parameters:

tokenSigningPublicKeys - The public keys used to validate the token signature returned by your custom authentication service. This parameter is required.

Returns:

this

See Also:

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

tokenSigningPublicKeys

@Stability(Stable)
public CfnAuthorizer.Builder tokenSigningPublicKeys(Map<String,String> tokenSigningPublicKeys)

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

Parameters:

tokenSigningPublicKeys - The public keys used to validate the token signature returned by your custom authentication service. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnAuthorizer build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnAuthorizer>

Returns:

a newly built instance of CfnAuthorizer.