class Logging (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.IoT.Alpha.Logging |
![]() | github.com/aws/aws-cdk-go/awscdkiotalpha/v2#Logging |
![]() | software.amazon.awscdk.services.iot.alpha.Logging |
![]() | aws_cdk.aws_iot_alpha.Logging |
![]() | @aws-cdk/aws-iot-alpha ยป Logging |
Implements
IConstruct
, IDependable
, IResource
, ILogging
Defines AWS IoT Logging.
Example
new iot.Logging(this, 'Logging', {
logLevel: iot.LogLevel.INFO,
});
Initializer
new Logging(scope: Construct, id: string, props?: LoggingProps)
Parameters
- scope
Construct
- id
string
- props
Logging
Props
Construct Props
Name | Type | Description |
---|---|---|
log | Log | The log level for the AWS IoT Logging. |
logLevel?
Type:
Log
(optional, default: LogLevel.ERROR)
The log level for the AWS IoT Logging.
Properties
Name | Type | Description |
---|---|---|
env | Resource | The environment this resource belongs to. |
log | string | The logging ID. |
node | Node | The tree node. |
stack | Stack | The stack in which this resource is defined. |
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
logId
Type:
string
The logging ID.
node
Type:
Node
The tree node.
stack
Type:
Stack
The stack in which this resource is defined.
Methods
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
to | Returns a string representation of this construct. |
static from | Import an existing AWS IoT Logging. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
).
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
static fromLogId(scope, id, logId)
public static fromLogId(scope: Construct, id: string, logId: string): ILogging
Parameters
- scope
Construct
โ The parent creating construct (usuallythis
). - id
string
โ The construct's name. - logId
string
โ AWS IoT Logging ID.
Returns
Import an existing AWS IoT Logging.