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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.850Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnAuthorizerProps.Builder	builder()
String	getAuthorizerFunctionArn() The authorizer's Lambda function ARN.
default String	getAuthorizerName() The authorizer name.
default Object	getEnableCachingForHttp() `AWS::IoT::Authorizer.EnableCachingForHttp`.
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 Detail

getAuthorizerFunctionArn

@Stability(value=Stable)
 @NotNull
String getAuthorizerFunctionArn()

The authorizer's Lambda function ARN.

getAuthorizerName

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

The authorizer name.

getEnableCachingForHttp

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

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

getSigningDisabled

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

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

getStatus

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

The status of the authorizer.

Valid values: ACTIVE | INACTIVE

getTags

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

getTokenKeyName

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

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

getTokenSigningPublicKeys

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

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

builder

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

Returns:

a CfnAuthorizerProps.Builder of CfnAuthorizerProps