software.amazon.awscdk.services.iot

Interface CfnAuthorizerProps

All Known Implementing Classes:

CfnAuthorizerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-02T20:25:25.979Z")
public interface CfnAuthorizerProps

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()
java.lang.String	getAuthorizerFunctionArn() The authorizer's Lambda function ARN.
default java.lang.String	getAuthorizerName() The authorizer name.
default java.lang.Object	getEnableCachingForHttp() `AWS::IoT::Authorizer.EnableCachingForHttp`.
default java.lang.Object	getSigningDisabled() Specifies whether AWS IoT validates the token signature in an authorization request.
default java.lang.String	getStatus() The status of the authorizer.
default java.util.List<CfnTag>	getTags() Metadata which can be used to manage the custom authorizer.
default java.lang.String	getTokenKeyName() The key used to extract the token from the HTTP headers.
default java.lang.Object	getTokenSigningPublicKeys() The public keys used to validate the token signature returned by your custom authentication service.

Method Detail

getAuthorizerFunctionArn

java.lang.String getAuthorizerFunctionArn()

The authorizer's Lambda function ARN.

getAuthorizerName

default java.lang.String getAuthorizerName()

The authorizer name.

getEnableCachingForHttp

default java.lang.Object getEnableCachingForHttp()

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

getSigningDisabled

default java.lang.Object getSigningDisabled()

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

getStatus

default java.lang.String getStatus()

The status of the authorizer.

Valid values: ACTIVE | INACTIVE

getTags

default java.util.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

default java.lang.String getTokenKeyName()

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

getTokenSigningPublicKeys

default java.lang.Object getTokenSigningPublicKeys()

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

builder

static CfnAuthorizerProps.Builder builder()

Returns:

a CfnAuthorizerProps.Builder of CfnAuthorizerProps