software.amazon.awscdk.services.iot

Class CfnAuthorizer

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.iot.CfnAuthorizer

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.849Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAuthorizer(software.constructs.Construct scope, 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
String	getAttrArn() The Amazon Resource Name (ARN) of the authorizer.
String	getAuthorizerFunctionArn() The authorizer's Lambda function ARN.
String	getAuthorizerName() The authorizer name.
protected Map<String,Object>	getCfnProperties()
Object	getEnableCachingForHttp() `AWS::IoT::Authorizer.EnableCachingForHttp`.
Object	getSigningDisabled() Specifies whether AWS IoT validates the token signature in an authorization request.
String	getStatus() The status of the authorizer.
TagManager	getTags() Metadata which can be used to manage the custom authorizer.
String	getTokenKeyName() The key used to extract the token from the HTTP headers.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAuthorizerFunctionArn(String value) The authorizer's Lambda function ARN.
void	setAuthorizerName(String value) The authorizer name.
void	setEnableCachingForHttp(Boolean value) `AWS::IoT::Authorizer.EnableCachingForHttp`.
void	setEnableCachingForHttp(IResolvable value) `AWS::IoT::Authorizer.EnableCachingForHttp`.
void	setSigningDisabled(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(String value) The status of the authorizer.
void	setTokenKeyName(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(Map<String,String> value) The public keys used to validate the token signature returned by your custom authentication service.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnAuthorizer(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id,
                                              @NotNull
                                              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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the authorizer.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

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

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

The authorizer's Lambda function ARN.

setAuthorizerFunctionArn

@Stability(value=Stable)
public void setAuthorizerFunctionArn(@NotNull
                                                              String value)

The authorizer's Lambda function ARN.

getAuthorizerName

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

The authorizer name.

setAuthorizerName

@Stability(value=Stable)
public void setAuthorizerName(@Nullable
                                                       String value)

The authorizer name.

getEnableCachingForHttp

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

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

setEnableCachingForHttp

@Stability(value=Stable)
public void setEnableCachingForHttp(@Nullable
                                                             Boolean value)

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

setEnableCachingForHttp

@Stability(value=Stable)
public void setEnableCachingForHttp(@Nullable
                                                             IResolvable value)

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

getSigningDisabled

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

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

setSigningDisabled

@Stability(value=Stable)
public void setSigningDisabled(@Nullable
                                                        Boolean value)

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

setSigningDisabled

@Stability(value=Stable)
public void setSigningDisabled(@Nullable
                                                        IResolvable value)

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

getStatus

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

The status of the authorizer.

Valid values: ACTIVE | INACTIVE

setStatus

@Stability(value=Stable)
public void setStatus(@Nullable
                                               String value)

The status of the authorizer.

Valid values: ACTIVE | INACTIVE

getTokenKeyName

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

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

setTokenKeyName

@Stability(value=Stable)
public void setTokenKeyName(@Nullable
                                                     String value)

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

getTokenSigningPublicKeys

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

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

setTokenSigningPublicKeys

@Stability(value=Stable)
public void setTokenSigningPublicKeys(@Nullable
                                                               IResolvable value)

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

setTokenSigningPublicKeys

@Stability(value=Stable)
public void setTokenSigningPublicKeys(@Nullable
                                                               Map<String,String> value)

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