Package software.amazon.awscdk.services.greengrass

Class CfnLoggerDefinition

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.greengrass.CfnLoggerDefinition
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.009Z") @Stability(Stable) public class CfnLoggerDefinition extends CfnResource implements IInspectable
A CloudFormation AWS::Greengrass::LoggerDefinition.

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();

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Application-specific metadata to attach to the logger definition.

      You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see Tagging Your AWS IoT Greengrass Resources in the Developer Guide .

      This Json property type is processed as a map of key-value pairs. It uses the following format, which is different from most Tags implementations in AWS CloudFormation templates. 

       "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
 }

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

      A logger definition version contains a list of logger property types.

      To associate a logger definition version after the logger definition is created, create an AWS::Greengrass::LoggerDefinitionVersion resource and specify the ID of this logger definition.

    • setInitialVersion

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

      A logger definition version contains a list of logger property types.

      To associate a logger definition version after the logger definition is created, create an AWS::Greengrass::LoggerDefinitionVersion resource and specify the ID of this logger definition.

    • setInitialVersion

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

      A logger definition version contains a list of logger property types.

      To associate a logger definition version after the logger definition is created, create an AWS::Greengrass::LoggerDefinitionVersion resource and specify the ID of this logger definition.