Class CfnAuthorizerProps.Builder
java.lang.Object
software.amazon.awscdk.services.iot.CfnAuthorizerProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnAuthorizerProps>
- Enclosing interface:
CfnAuthorizerProps
@Stability(Stable)
public static final class CfnAuthorizerProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAuthorizerProps>
A builder for
CfnAuthorizerProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionauthorizerFunctionArn
(String authorizerFunctionArn) Sets the value ofCfnAuthorizerProps.getAuthorizerFunctionArn()
authorizerName
(String authorizerName) Sets the value ofCfnAuthorizerProps.getAuthorizerName()
build()
Builds the configured instance.enableCachingForHttp
(Boolean enableCachingForHttp) Sets the value ofCfnAuthorizerProps.getEnableCachingForHttp()
enableCachingForHttp
(IResolvable enableCachingForHttp) Sets the value ofCfnAuthorizerProps.getEnableCachingForHttp()
signingDisabled
(Boolean signingDisabled) Sets the value ofCfnAuthorizerProps.getSigningDisabled()
signingDisabled
(IResolvable signingDisabled) Sets the value ofCfnAuthorizerProps.getSigningDisabled()
Sets the value ofCfnAuthorizerProps.getStatus()
Sets the value ofCfnAuthorizerProps.getTags()
tokenKeyName
(String tokenKeyName) Sets the value ofCfnAuthorizerProps.getTokenKeyName()
tokenSigningPublicKeys
(Map<String, String> tokenSigningPublicKeys) Sets the value ofCfnAuthorizerProps.getTokenSigningPublicKeys()
tokenSigningPublicKeys
(IResolvable tokenSigningPublicKeys) Sets the value ofCfnAuthorizerProps.getTokenSigningPublicKeys()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
authorizerFunctionArn
@Stability(Stable) public CfnAuthorizerProps.Builder authorizerFunctionArn(String authorizerFunctionArn) Sets the value ofCfnAuthorizerProps.getAuthorizerFunctionArn()
- Parameters:
authorizerFunctionArn
- The authorizer's Lambda function ARN. This parameter is required.- Returns:
this
-
authorizerName
Sets the value ofCfnAuthorizerProps.getAuthorizerName()
- Parameters:
authorizerName
- The authorizer name.- Returns:
this
-
enableCachingForHttp
@Stability(Stable) public CfnAuthorizerProps.Builder enableCachingForHttp(Boolean enableCachingForHttp) Sets the value ofCfnAuthorizerProps.getEnableCachingForHttp()
- Parameters:
enableCachingForHttp
- Whentrue
, 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 inrefreshAfterInSeconds
. This value doesn't affect authorization of clients that use MQTT connections.- Returns:
this
-
enableCachingForHttp
@Stability(Stable) public CfnAuthorizerProps.Builder enableCachingForHttp(IResolvable enableCachingForHttp) Sets the value ofCfnAuthorizerProps.getEnableCachingForHttp()
- Parameters:
enableCachingForHttp
- Whentrue
, 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 inrefreshAfterInSeconds
. This value doesn't affect authorization of clients that use MQTT connections.- Returns:
this
-
signingDisabled
Sets the value ofCfnAuthorizerProps.getSigningDisabled()
- Parameters:
signingDisabled
- Specifies whether AWS IoT validates the token signature in an authorization request.- Returns:
this
-
signingDisabled
Sets the value ofCfnAuthorizerProps.getSigningDisabled()
- Parameters:
signingDisabled
- Specifies whether AWS IoT validates the token signature in an authorization request.- Returns:
this
-
status
Sets the value ofCfnAuthorizerProps.getStatus()
- Parameters:
status
- The status of the authorizer. Valid values:ACTIVE
|INACTIVE
- Returns:
this
-
tags
Sets the value ofCfnAuthorizerProps.getTags()
- Parameters:
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..."
- Returns:
this
-
tokenKeyName
Sets the value ofCfnAuthorizerProps.getTokenKeyName()
- Parameters:
tokenKeyName
- The key used to extract the token from the HTTP headers.- Returns:
this
-
tokenSigningPublicKeys
@Stability(Stable) public CfnAuthorizerProps.Builder tokenSigningPublicKeys(IResolvable tokenSigningPublicKeys) Sets the value ofCfnAuthorizerProps.getTokenSigningPublicKeys()
- Parameters:
tokenSigningPublicKeys
- The public keys used to validate the token signature returned by your custom authentication service.- Returns:
this
-
tokenSigningPublicKeys
@Stability(Stable) public CfnAuthorizerProps.Builder tokenSigningPublicKeys(Map<String, String> tokenSigningPublicKeys) Sets the value ofCfnAuthorizerProps.getTokenSigningPublicKeys()
- Parameters:
tokenSigningPublicKeys
- The public keys used to validate the token signature returned by your custom authentication service.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnAuthorizerProps>
- Returns:
- a new instance of
CfnAuthorizerProps
- Throws:
NullPointerException
- if any required attribute was not provided
-