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(value=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 and 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) `AWS::IoT::Authorizer.EnableCachingForHttp`.
CfnAuthorizer.Builder	enableCachingForHttp(IResolvable enableCachingForHttp) `AWS::IoT::Authorizer.EnableCachingForHttp`.
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(IResolvable tokenSigningPublicKeys) The public keys used to validate the token signature returned by your custom authentication service.
CfnAuthorizer.Builder	tokenSigningPublicKeys(Map<String,String> 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 Detail

create

@Stability(value=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 - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnAuthorizer.Builder.

authorizerFunctionArn

@Stability(value=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

authorizerName

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

The authorizer name.

Parameters:

authorizerName - The authorizer name. This parameter is required.

Returns:

this

enableCachingForHttp

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

`AWS::IoT::Authorizer.EnableCachingForHttp`.

Parameters:

enableCachingForHttp - `AWS::IoT::Authorizer.EnableCachingForHttp`. This parameter is required.

Returns:

this

enableCachingForHttp

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

`AWS::IoT::Authorizer.EnableCachingForHttp`.

Parameters:

enableCachingForHttp - `AWS::IoT::Authorizer.EnableCachingForHttp`. This parameter is required.

Returns:

this

signingDisabled

@Stability(value=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

signingDisabled

@Stability(value=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

status

@Stability(value=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

tags

@Stability(value=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

tokenKeyName

@Stability(value=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

tokenSigningPublicKeys

@Stability(value=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

tokenSigningPublicKeys

@Stability(value=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

build

@Stability(value=Stable)
public CfnAuthorizer build()

Specified by:

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