Package software.amazon.awscdk.services.iot

Class CfnLogging

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.CfnLogging
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ILoggingRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-12T17:54:15.124Z") @Stability(Stable) public class CfnLogging extends CfnResource implements IInspectable, ILoggingRef
Configure logging.

If you already set the log function of AWS IoT Core , you can't deploy the Cloud Development Kit to change the logging settings. You can change the logging settings by either:

  • Importing the existing logging resource into your CloudFormation stack, such as with the infrastructure as code generator (IaC generator) .
  • Calling aws iot set-v2-logging-options --disable-all-logs before creating a new CloudFormation stack. This command disables all AWS IoT logging. As a result, no AWS IoT logs will be delivered to Amazon CloudWatch until you re-enable logging.

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.*;
 CfnLogging cfnLogging = CfnLogging.Builder.create(this, "MyCfnLogging")
         .accountId("accountId")
         .defaultLogLevel("defaultLogLevel")
         .roleArn("roleArn")
         .build();

See Also:

  • 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

    • CfnLogging

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

    • CfnLogging

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

    • CfnLogging

      @Stability(Stable) public CfnLogging(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnLoggingProps props)
      Create a new AWS::IoT::Logging.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • isCfnLogging

      @Stability(Stable) @NotNull public static Boolean isCfnLogging(@NotNull Object x)
      Checks whether the given object is a CfnLogging.

      Parameters:
      x - This parameter is required.

    • 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.

    • getCfnProperties

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

    • getLoggingRef

      @Stability(Stable) @NotNull public LoggingReference getLoggingRef()
      A reference to a Logging resource.
      Specified by:
      getLoggingRef in interface ILoggingRef

    • getAccountId

      @Stability(Stable) @NotNull public String getAccountId()
      The account ID.

    • setAccountId

      @Stability(Stable) public void setAccountId(@NotNull String value)
      The account ID.

    • getDefaultLogLevel

      @Stability(Stable) @NotNull public String getDefaultLogLevel()
      The default log level.

    • setDefaultLogLevel

      @Stability(Stable) public void setDefaultLogLevel(@NotNull String value)
      The default log level.

    • getRoleArn

      @Stability(Stable) @NotNull public String getRoleArn()
      The role ARN used for the log.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@NotNull String value)
      The role ARN used for the log.