software.amazon.awscdk.services.iot

Class CfnAuthorizer

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.iot.CfnAuthorizer

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-18T02:14:04.823Z")
public class CfnAuthorizer
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoT::Authorizer`.

Specifies an authorizer.

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.*;
 CfnAuthorizer cfnAuthorizer = CfnAuthorizer.Builder.create(this, "MyCfnAuthorizer")
         .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	Class and Description
static class	CfnAuthorizer.Builder A fluent builder for CfnAuthorizer.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAuthorizer(Construct scope, java.lang.String id, CfnAuthorizerProps props) Create a new `AWS::IoT::Authorizer`.
protected	CfnAuthorizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAuthorizer(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn() The Amazon Resource Name (ARN) of the authorizer.
java.lang.String	getAuthorizerFunctionArn() The authorizer's Lambda function ARN.
java.lang.String	getAuthorizerName() The authorizer name.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getEnableCachingForHttp() `AWS::IoT::Authorizer.EnableCachingForHttp`.
java.lang.Object	getSigningDisabled() Specifies whether AWS IoT validates the token signature in an authorization request.
java.lang.String	getStatus() The status of the authorizer.
TagManager	getTags() Metadata which can be used to manage the custom authorizer.
java.lang.String	getTokenKeyName() The key used to extract the token from the HTTP headers.
java.lang.Object	getTokenSigningPublicKeys() The public keys used to validate the token signature returned by your custom authentication service.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAuthorizerFunctionArn(java.lang.String value) The authorizer's Lambda function ARN.
void	setAuthorizerName(java.lang.String value) The authorizer name.
void	setEnableCachingForHttp(java.lang.Boolean value) `AWS::IoT::Authorizer.EnableCachingForHttp`.
void	setEnableCachingForHttp(IResolvable value) `AWS::IoT::Authorizer.EnableCachingForHttp`.
void	setSigningDisabled(java.lang.Boolean value) Specifies whether AWS IoT validates the token signature in an authorization request.
void	setSigningDisabled(IResolvable value) Specifies whether AWS IoT validates the token signature in an authorization request.
void	setStatus(java.lang.String value) The status of the authorizer.
void	setTokenKeyName(java.lang.String value) The key used to extract the token from the HTTP headers.
void	setTokenSigningPublicKeys(IResolvable value) The public keys used to validate the token signature returned by your custom authentication service.
void	setTokenSigningPublicKeys(java.util.Map<java.lang.String,java.lang.String> value) The public keys used to validate the token signature returned by your custom authentication service.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnAuthorizer

protected CfnAuthorizer(software.amazon.jsii.JsiiObjectRef objRef)

CfnAuthorizer

protected CfnAuthorizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnAuthorizer

public CfnAuthorizer(Construct scope,
                     java.lang.String id,
                     CfnAuthorizerProps props)

Create a new `AWS::IoT::Authorizer`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

The Amazon Resource Name (ARN) of the authorizer.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

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

getAuthorizerFunctionArn

public java.lang.String getAuthorizerFunctionArn()

The authorizer's Lambda function ARN.

setAuthorizerFunctionArn

public void setAuthorizerFunctionArn(java.lang.String value)

The authorizer's Lambda function ARN.

getAuthorizerName

public java.lang.String getAuthorizerName()

The authorizer name.

setAuthorizerName

public void setAuthorizerName(java.lang.String value)

The authorizer name.

getEnableCachingForHttp

public java.lang.Object getEnableCachingForHttp()

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

setEnableCachingForHttp

public void setEnableCachingForHttp(java.lang.Boolean value)

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

setEnableCachingForHttp

public void setEnableCachingForHttp(IResolvable value)

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

getSigningDisabled

public java.lang.Object getSigningDisabled()

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

setSigningDisabled

public void setSigningDisabled(java.lang.Boolean value)

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

setSigningDisabled

public void setSigningDisabled(IResolvable value)

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

getStatus

public java.lang.String getStatus()

The status of the authorizer.

Valid values: ACTIVE | INACTIVE

setStatus

public void setStatus(java.lang.String value)

The status of the authorizer.

Valid values: ACTIVE | INACTIVE

getTokenKeyName

public java.lang.String getTokenKeyName()

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

setTokenKeyName

public void setTokenKeyName(java.lang.String value)

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

getTokenSigningPublicKeys

public java.lang.Object getTokenSigningPublicKeys()

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

setTokenSigningPublicKeys

public void setTokenSigningPublicKeys(IResolvable value)

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

setTokenSigningPublicKeys

public void setTokenSigningPublicKeys(java.util.Map<java.lang.String,java.lang.String> value)

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