software.amazon.awscdk.services.logs

Class CfnLogGroupProps.Builder

java.lang.Object

software.amazon.awscdk.services.logs.CfnLogGroupProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLogGroupProps>

Enclosing interface:

CfnLogGroupProps

@Stability(value=Stable)
public static final class CfnLogGroupProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnLogGroupProps>

A builder for CfnLogGroupProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnLogGroupProps	build() Builds the configured instance.
CfnLogGroupProps.Builder	kmsKeyId(String kmsKeyId) Sets the value of CfnLogGroupProps.getKmsKeyId()
CfnLogGroupProps.Builder	logGroupName(String logGroupName) Sets the value of CfnLogGroupProps.getLogGroupName()
CfnLogGroupProps.Builder	retentionInDays(Number retentionInDays) Sets the value of CfnLogGroupProps.getRetentionInDays()
CfnLogGroupProps.Builder	tags(List<? extends CfnTag> tags) Sets the value of CfnLogGroupProps.getTags()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

kmsKeyId

@Stability(value=Stable)
public CfnLogGroupProps.Builder kmsKeyId(String kmsKeyId)

Sets the value of CfnLogGroupProps.getKmsKeyId()

Parameters:

kmsKeyId - The Amazon Resource Name (ARN) of the AWS KMS key to use when encrypting log data. To associate an AWS KMS key with the log group, specify the ARN of that KMS key here. If you do so, ingested data is encrypted using this 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 doesn't exist or is deactivated, you will receive an InvalidParameterException error.

Log group data is always encrypted in CloudWatch Logs . If you omit this key, the encryption does not use AWS KMS . For more information, see Encrypt log data in CloudWatch Logs using AWS Key Management Service

Returns:

this

logGroupName

@Stability(value=Stable)
public CfnLogGroupProps.Builder logGroupName(String logGroupName)

Sets the value of CfnLogGroupProps.getLogGroupName()

Parameters:

logGroupName - The name of the log group. If you don't specify a name, AWS CloudFormation generates a unique ID for the log group.

Returns:

this

retentionInDays

@Stability(value=Stable)
public CfnLogGroupProps.Builder retentionInDays(Number retentionInDays)

Sets the value of CfnLogGroupProps.getRetentionInDays()

Parameters:

retentionInDays - The number of days to retain the 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, 1827, 2192, 2557, 2922, 3288, and 3653.

To set a log group to never have log events expire, use DeleteRetentionPolicy .

Returns:

this

tags

@Stability(value=Stable)
public CfnLogGroupProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnLogGroupProps.getTags()

Parameters:

tags - An array of key-value pairs to apply to the log group. For more information, see Tag .

Returns:

this

build

@Stability(value=Stable)
public CfnLogGroupProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnLogGroupProps>

Returns:

a new instance of CfnLogGroupProps

Throws:

NullPointerException - if any required attribute was not provided