Package software.amazon.awscdk.services.greengrass

Class CfnLoggerDefinition

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.greengrass.CfnLoggerDefinition
All Implemented Interfaces:
IInspectable, ILoggerDefinitionRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)", date="2026-01-19T12:03:55.378Z") @Stability(Stable) public class CfnLoggerDefinition extends CfnResource implements IInspectable, ILoggerDefinitionRef, ITaggable
The AWS::Greengrass::LoggerDefinition resource represents a logger definition for AWS IoT Greengrass .

Logger definitions are used to organize your logger definition versions.

Logger definitions can reference multiple logger definition versions. All logger definition versions must be associated with a logger definition. Each logger definition version can contain one or more loggers.

When you create a logger definition, you can optionally include an initial logger definition version. To associate a logger definition version later, create an AWS::Greengrass::LoggerDefinitionVersion resource and specify the ID of this logger definition.

After you create the logger definition version that contains the loggers you want to deploy, you must add it to your group version. For more information, see AWS::Greengrass::Group .

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.greengrass.*;
 Object tags;
 CfnLoggerDefinition cfnLoggerDefinition = CfnLoggerDefinition.Builder.create(this, "MyCfnLoggerDefinition")
         .name("name")
         // the properties below are optional
         .initialVersion(LoggerDefinitionVersionProperty.builder()
                 .loggers(List.of(LoggerProperty.builder()
                         .component("component")
                         .id("id")
                         .level("level")
                         .type("type")
                         // the properties below are optional
                         .space(123)
                         .build()))
                 .build())
         .tags(tags)
         .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

    • CfnLoggerDefinition

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

    • CfnLoggerDefinition

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

    • CfnLoggerDefinition

      @Stability(Stable) public CfnLoggerDefinition(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnLoggerDefinitionProps props)
      Create a new AWS::Greengrass::LoggerDefinition.

      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

    • arnForLoggerDefinition

      @Stability(Stable) @NotNull public static String arnForLoggerDefinition(@NotNull ILoggerDefinitionRef resource)
      Parameters:
      resource - This parameter is required.

    • fromLoggerDefinitionArn

      @Stability(Stable) @NotNull public static ILoggerDefinitionRef fromLoggerDefinitionArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new ILoggerDefinitionRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromLoggerDefinitionId

      @Stability(Stable) @NotNull public static ILoggerDefinitionRef fromLoggerDefinitionId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String loggerDefinitionId)
      Creates a new ILoggerDefinitionRef from a loggerDefinitionId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      loggerDefinitionId - This parameter is required.

    • isCfnLoggerDefinition

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

      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.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the LoggerDefinition , such as arn:aws:greengrass:us-east-1: :/greengrass/definition/loggers/1234a5b6-78cd-901e-2fgh-3i45j6k178l9 .

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the LoggerDefinition , such as 1234a5b6-78cd-901e-2fgh-3i45j6k178l9 .

    • getAttrLatestVersionArn

      @Stability(Stable) @NotNull public String getAttrLatestVersionArn()
      The ARN of the last LoggerDefinitionVersion that was added to the LoggerDefinition , such as arn:aws:greengrass:us-east-1: :/greengrass/definition/loggers/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2 .

    • getAttrName

      @Stability(Stable) @NotNull public String getAttrName()
      The name of the LoggerDefinition , such as MyLoggerDefinition .

    • getCfnProperties

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

    • getLoggerDefinitionRef

      @Stability(Stable) @NotNull public LoggerDefinitionReference getLoggerDefinitionRef()
      A reference to a LoggerDefinition resource.
      Specified by:
      getLoggerDefinitionRef in interface ILoggerDefinitionRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the logger definition.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the logger definition.

    • getInitialVersion

      @Stability(Stable) @Nullable public Object getInitialVersion()
      The logger definition version to include when the logger definition is created.

      Returns union: either IResolvable or CfnLoggerDefinition.LoggerDefinitionVersionProperty

    • setInitialVersion

      @Stability(Stable) public void setInitialVersion(@Nullable IResolvable value)
      The logger definition version to include when the logger definition is created.

    • setInitialVersion

      @Stability(Stable) public void setInitialVersion(@Nullable CfnLoggerDefinition.LoggerDefinitionVersionProperty value)
      The logger definition version to include when the logger definition is created.

    • getTagsRaw

      @Stability(Stable) @Nullable public Object getTagsRaw()
      Application-specific metadata to attach to the logger definition.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable Object value)
      Application-specific metadata to attach to the logger definition.