LogGroup class

Provides a CloudWatch Log Group resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const yada = new aws.cloudwatch.LogGroup("yada", {
    name: "Yada",
    tags: {
        Environment: "production",
        Application: "serviceA",
    },
});

import pulumi
import pulumi_aws as aws

yada = aws.cloudwatch.LogGroup("yada",
    name="Yada",
    tags={
        "Environment": "production",
        "Application": "serviceA",
    })

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var yada = new Aws.CloudWatch.LogGroup("yada", new()
    {
        Name = "Yada",
        Tags =
        {
            { "Environment", "production" },
            { "Application", "serviceA" },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cloudwatch"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudwatch.NewLogGroup(ctx, "yada", &cloudwatch.LogGroupArgs{
			Name: pulumi.String("Yada"),
			Tags: pulumi.StringMap{
				"Environment": pulumi.String("production"),
				"Application": pulumi.String("serviceA"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_cloudwatch_loggroup" "yada" {
  name = "Yada"
  tags = {
    "Environment" = "production"
    "Application" = "serviceA"
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudwatch.LogGroup;
import com.pulumi.aws.cloudwatch.LogGroupArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var yada = new LogGroup("yada", LogGroupArgs.builder()
            .name("Yada")
            .tags(Map.ofEntries(
                Map.entry("Environment", "production"),
                Map.entry("Application", "serviceA")
            ))
            .build());

    }
}

resources:
  yada:
    type: aws:cloudwatch:LogGroup
    properties:
      name: Yada
      tags:
        Environment: production
        Application: serviceA

Import

Identity Schema

Required

name (String) Name of the CloudWatch log group.

Optional

accountId (String) AWS Account where this resource is managed.
region (String) Region where this resource is managed.

Using pulumi import, import Cloudwatch Log Groups using the name. For example:

$ pulumi import aws:cloudwatch/logGroup:LogGroup example yada

Constructors

LogGroup(String name, {LogGroupArgs? args, CustomResourceOptions? options}): Creates a new LogGroup. name The Pulumi resource name. args Arguments used to configure this LogGroup. The set of arguments for LogGroup. options Resource options controlling this resource's behavior.
LogGroup.reference(String urn): Creates a typed reference to an existing LogGroup resource.

Properties

arn ↔ Output<String>: ARN specifying the log group. Any :* suffix added by the API, denoting all CloudWatch Log Streams under the CloudWatch Log Group, is removed for greater compatibility with other AWS services that do not accept the suffix.
latefinal
childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
deletionProtectionEnabled ↔ Output<bool>: Boolean to indicate whether deletion protection is enabled. Defaults to false. Once set, switching to false requires explicitly specifying false rather than removing this argument.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
kmsKeyId ↔ Output<String?>: The ARN of the KMS Key to use when encrypting log data. Please note, after the AWS KMS CMK is disassociated from the log group, AWS CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and AWS CloudWatch Logs requires permissions for the CMK whenever the encrypted data is requested.
latefinal
logGroupClass ↔ Output<String>: Specified the log class of the log group. Possible values are: STANDARD, INFREQUENT_ACCESS, or DELIVERY.
latefinal
name ↔ Output<String>: The name of the log group. If omitted, this provider will assign a random, unique name.
latefinal
namePrefix ↔ Output<String>: Creates a unique name beginning with the specified prefix. Conflicts with name.
latefinal
region ↔ Output<String>: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
retentionInDays ↔ Output<int?>: Specifies the number of days you want to retain log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, 3653, and 0. If you select 0, the events in the log group are always retained and never expire. If logGroupClass is set to DELIVERY, this argument is ignored and retentionInDays is forcibly set to 2.
latefinal
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
skipDestroy ↔ Output<bool?>: Set to true if you do not wish the log group (and any logs it may contain) to be deleted at destroy time, and instead just remove the log group from the state.
latefinal
tags ↔ Output<Map<String, String>?>: A map of tags to assign to the resource. .If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>: A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>: latefinalinherited

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {LogGroupState? state, CustomResourceOptions? options}) → LogGroup: Gets an existing LogGroup resource's state with the given name and id.

LogGroup class

Example Usage

Import

Identity Schema

Required

Optional

Constructors

Properties

Methods

Operators

Static Methods

cloudwatch library