Package software.amazon.awscdk.services.iot

Class CfnAuthorizer

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.519Z") @Stability(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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAuthorizer

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

    • CfnAuthorizer

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

    • CfnAuthorizer

      @Stability(Stable) public CfnAuthorizer(@NotNull 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the authorizer.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(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(Stable) @NotNull public String getAuthorizerFunctionArn()
      The authorizer's Lambda function ARN.

    • setAuthorizerFunctionArn

      @Stability(Stable) public void setAuthorizerFunctionArn(@NotNull String value)
      The authorizer's Lambda function ARN.

    • getAuthorizerName

      @Stability(Stable) @Nullable public String getAuthorizerName()
      The authorizer name.

    • setAuthorizerName

      @Stability(Stable) public void setAuthorizerName(@Nullable String value)
      The authorizer name.

    • getEnableCachingForHttp

      @Stability(Stable) @Nullable public Object getEnableCachingForHttp()
      AWS::IoT::Authorizer.EnableCachingForHttp.

    • setEnableCachingForHttp

      @Stability(Stable) public void setEnableCachingForHttp(@Nullable Boolean value)
      AWS::IoT::Authorizer.EnableCachingForHttp.

    • setEnableCachingForHttp

      @Stability(Stable) public void setEnableCachingForHttp(@Nullable IResolvable value)
      AWS::IoT::Authorizer.EnableCachingForHttp.

    • getSigningDisabled

      @Stability(Stable) @Nullable public Object getSigningDisabled()
      Specifies whether AWS IoT validates the token signature in an authorization request.

    • setSigningDisabled

      @Stability(Stable) public void setSigningDisabled(@Nullable Boolean value)
      Specifies whether AWS IoT validates the token signature in an authorization request.

    • setSigningDisabled

      @Stability(Stable) public void setSigningDisabled(@Nullable IResolvable value)
      Specifies whether AWS IoT validates the token signature in an authorization request.

    • getStatus

      @Stability(Stable) @Nullable public String getStatus()
      The status of the authorizer.

      Valid values: ACTIVE | INACTIVE

    • setStatus

      @Stability(Stable) public void setStatus(@Nullable String value)
      The status of the authorizer.

      Valid values: ACTIVE | INACTIVE

    • getTokenKeyName

      @Stability(Stable) @Nullable public String getTokenKeyName()
      The key used to extract the token from the HTTP headers.

    • setTokenKeyName

      @Stability(Stable) public void setTokenKeyName(@Nullable String value)
      The key used to extract the token from the HTTP headers.

    • getTokenSigningPublicKeys

      @Stability(Stable) @Nullable public Object getTokenSigningPublicKeys()
      The public keys used to validate the token signature returned by your custom authentication service.

    • setTokenSigningPublicKeys

      @Stability(Stable) public void setTokenSigningPublicKeys(@Nullable IResolvable value)
      The public keys used to validate the token signature returned by your custom authentication service.

    • setTokenSigningPublicKeys

      @Stability(Stable) public void setTokenSigningPublicKeys(@Nullable Map<String,String> value)
      The public keys used to validate the token signature returned by your custom authentication service.