AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Creates a log group with the specified name. You can create up to 1,000,000 log groups per Region per account.

You must use the following guidelines when naming a log group:

When you create a log group, by default the log events in the log group do not expire. To set a retention policy so that events expire and are deleted after a specified time, use PutRetentionPolicy.

If you associate an KMS key with the log group, ingested data is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.

If you attempt to associate a KMS key with the log group but the KMS key does not exist or the KMS key is disabled, you receive an InvalidParameterException error.

CloudWatch Logs supports only symmetric KMS keys. Do not associate an asymmetric KMS key with your log group. For more information, see Using Symmetric and Asymmetric Keys.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginCreateLogGroup and EndCreateLogGroup.

Namespace: Amazon.CloudWatchLogs
Assembly: AWSSDK.CloudWatchLogs.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<CreateLogGroupResponse> CreateLogGroupAsync(
         CreateLogGroupRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CloudWatchLogs.Model.CreateLogGroupRequest

Container for the necessary parameters to execute the CreateLogGroup service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the CreateLogGroup service method, as returned by CloudWatchLogs.

Exceptions

ExceptionCondition
InvalidParameterException A parameter is specified incorrectly.
LimitExceededException You have reached the maximum number of resources that can be created.
OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
ResourceAlreadyExistsException The specified resource already exists.
ServiceUnavailableException The service cannot complete the request.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also