@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)", date="2022-12-07T17:24:35.181Z") @Stability(value=Stable) public class CfnLoggerDefinition extends CfnResource implements IInspectable
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::LoggerDefinitionVersionresource 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();
| Modifier and Type | Class and Description |
|---|---|
static class |
CfnLoggerDefinition.Builder
A fluent builder for
CfnLoggerDefinition. |
static interface |
CfnLoggerDefinition.LoggerDefinitionVersionProperty
A logger definition version contains a list of [loggers](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html) .
|
static interface |
CfnLoggerDefinition.LoggerProperty
A logger represents logging settings for the AWS IoT Greengrass group, which can be stored in CloudWatch and the local file system of your core device.
|
software.amazon.jsii.JsiiObject.InitializationModeIInspectable.Jsii$Default, IInspectable.Jsii$ProxyIConstruct.Jsii$Default| Modifier and Type | Field and Description |
|---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnLoggerDefinition(Construct scope,
String id,
CfnLoggerDefinitionProps props)
Create a new `AWS::Greengrass::LoggerDefinition`.
|
protected |
CfnLoggerDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnLoggerDefinition(software.amazon.jsii.JsiiObjectRef objRef) |
| Modifier and Type | Method and Description |
|---|---|
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` .
|
String |
getAttrId()
The ID of the `LoggerDefinition` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
|
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` .
|
String |
getAttrName()
The name of the `LoggerDefinition` , such as `MyLoggerDefinition` .
|
protected Map<String,Object> |
getCfnProperties() |
Object |
getInitialVersion()
The logger definition version to include when the logger definition is created.
|
String |
getName()
The name of the logger definition.
|
TagManager |
getTags()
Application-specific metadata to attach to the logger definition.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected Map<String,Object> |
renderProperties(Map<String,Object> props) |
void |
setInitialVersion(CfnLoggerDefinition.LoggerDefinitionVersionProperty value)
The logger definition version to include when the logger definition is created.
|
void |
setInitialVersion(IResolvable value)
The logger definition version to include when the logger definition is created.
|
void |
setName(String value)
The name of the logger definition.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdgetNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validatejsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnLoggerDefinition(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnLoggerDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CfnLoggerDefinition(@NotNull
Construct scope,
@NotNull
String id,
@NotNull
CfnLoggerDefinitionProps props)
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.@Stability(value=Stable)
public void inspect(@NotNull
TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties in class CfnResourceprops - This parameter is required.@Stability(value=Stable) @NotNull public String getAttrArn()
@Stability(value=Stable) @NotNull public String getAttrId()
@Stability(value=Stable) @NotNull public String getAttrLatestVersionArn()
@Stability(value=Stable) @NotNull public String getAttrName()
@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties in class CfnResource@Stability(value=Stable) @NotNull public TagManager getTags()
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"
}
@Stability(value=Stable) @NotNull public String getName()
@Stability(value=Stable)
public void setName(@NotNull
String value)
@Stability(value=Stable) @Nullable public Object getInitialVersion()
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::LoggerDefinitionVersionresource and specify the ID of this logger definition.
@Stability(value=Stable)
public void setInitialVersion(@Nullable
IResolvable value)
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::LoggerDefinitionVersionresource and specify the ID of this logger definition.
@Stability(value=Stable)
public void setInitialVersion(@Nullable
CfnLoggerDefinition.LoggerDefinitionVersionProperty value)
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::LoggerDefinitionVersionresource and specify the ID of this logger definition.
Copyright © 2022. All rights reserved.