Package software.amazon.awscdk.cfnpropertymixins.services.logs

Class CfnLogGroupPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.logs.CfnLogGroupPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLogGroupPropsMixin>

Enclosing class:

CfnLogGroupPropsMixin

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

A fluent builder for CfnLogGroupPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnLogGroupPropsMixin	build()
static CfnLogGroupPropsMixin.Builder	create()
static CfnLogGroupPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnLogGroupPropsMixin.Builder	dataProtectionPolicy(Object dataProtectionPolicy)	Creates a data protection policy and assigns it to the log group.
CfnLogGroupPropsMixin.Builder	deletionProtectionEnabled(Boolean deletionProtectionEnabled)	Indicates whether deletion protection is enabled for this log group.
CfnLogGroupPropsMixin.Builder	deletionProtectionEnabled(IResolvable deletionProtectionEnabled)	Indicates whether deletion protection is enabled for this log group.
CfnLogGroupPropsMixin.Builder	fieldIndexPolicies(List<? extends Object> fieldIndexPolicies)	Creates or updates a field index policy for the specified log group.
CfnLogGroupPropsMixin.Builder	fieldIndexPolicies(IResolvable fieldIndexPolicies)	Creates or updates a field index policy for the specified log group.
CfnLogGroupPropsMixin.Builder	kmsKeyId(String kmsKeyId)	The Amazon Resource Name (ARN) of the AWS key to use when encrypting log data.
CfnLogGroupPropsMixin.Builder	kmsKeyId(IKeyRef kmsKeyId)	The Amazon Resource Name (ARN) of the AWS key to use when encrypting log data.
CfnLogGroupPropsMixin.Builder	logGroupClass(String logGroupClass)	Specifies the log group class for this log group.
CfnLogGroupPropsMixin.Builder	logGroupName(String logGroupName)	The name of the log group.
CfnLogGroupPropsMixin.Builder	logGroupName(IFunctionRef logGroupName)	The name of the log group.
CfnLogGroupPropsMixin.Builder	resourcePolicyDocument(Object resourcePolicyDocument)	Creates or updates a resource policy for the specified log group that allows other services to put log events to this account.
CfnLogGroupPropsMixin.Builder	retentionInDays(Number retentionInDays)	The number of days to retain the log events in the specified log group.
CfnLogGroupPropsMixin.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs to apply to the log group.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnLogGroupPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnLogGroupPropsMixin.Builder.

create

@Stability(Stable)
public static CfnLogGroupPropsMixin.Builder create()

Returns:

a new instance of CfnLogGroupPropsMixin.Builder.

dataProtectionPolicy

@Stability(Stable)
public CfnLogGroupPropsMixin.Builder dataProtectionPolicy(Object dataProtectionPolicy)

Creates a data protection policy and assigns it to the log group.

A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data. When a user who does not have permission to view masked data views a log event that includes masked data, the sensitive data is replaced by asterisks.

Parameters:

dataProtectionPolicy - Creates a data protection policy and assigns it to the log group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-dataprotectionpolicy

deletionProtectionEnabled

@Stability(Stable)
public CfnLogGroupPropsMixin.Builder deletionProtectionEnabled(Boolean deletionProtectionEnabled)

Indicates whether deletion protection is enabled for this log group.

When enabled, deletion protection blocks all deletion operations until it is explicitly disabled.

Default: - false

Parameters:

deletionProtectionEnabled - Indicates whether deletion protection is enabled for this log group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-deletionprotectionenabled

deletionProtectionEnabled

@Stability(Stable)
public CfnLogGroupPropsMixin.Builder deletionProtectionEnabled(IResolvable deletionProtectionEnabled)

Indicates whether deletion protection is enabled for this log group.

When enabled, deletion protection blocks all deletion operations until it is explicitly disabled.

Default: - false

Parameters:

deletionProtectionEnabled - Indicates whether deletion protection is enabled for this log group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-deletionprotectionenabled

fieldIndexPolicies

@Stability(Stable)
public CfnLogGroupPropsMixin.Builder fieldIndexPolicies(List<? extends Object> fieldIndexPolicies)

Creates or updates a field index policy for the specified log group.

Only log groups in the Standard log class support field index policies. For more information about log classes, see Log classes .

You can use field index policies to create field indexes on fields found in log events in the log group. Creating field indexes lowers the costs for CloudWatch Logs Insights queries that reference those field indexes, because these queries attempt to skip the processing of log events that are known to not match the indexed field. Good fields to index are fields that you often need to query for and fields that have high cardinality of values Common examples of indexes include request ID, session ID, userID, and instance IDs. For more information, see Create field indexes to improve query performance and reduce costs .

Currently, this array supports only one field index policy object.

Parameters:

fieldIndexPolicies - Creates or updates a field index policy for the specified log group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-fieldindexpolicies

fieldIndexPolicies

@Stability(Stable)
public CfnLogGroupPropsMixin.Builder fieldIndexPolicies(IResolvable fieldIndexPolicies)

Creates or updates a field index policy for the specified log group.

Only log groups in the Standard log class support field index policies. For more information about log classes, see Log classes .

You can use field index policies to create field indexes on fields found in log events in the log group. Creating field indexes lowers the costs for CloudWatch Logs Insights queries that reference those field indexes, because these queries attempt to skip the processing of log events that are known to not match the indexed field. Good fields to index are fields that you often need to query for and fields that have high cardinality of values Common examples of indexes include request ID, session ID, userID, and instance IDs. For more information, see Create field indexes to improve query performance and reduce costs .

Currently, this array supports only one field index policy object.

Parameters:

fieldIndexPolicies - Creates or updates a field index policy for the specified log group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-fieldindexpolicies

kmsKeyId

@Stability(Stable)
public CfnLogGroupPropsMixin.Builder kmsKeyId(String kmsKeyId)

The Amazon Resource Name (ARN) of the AWS key to use when encrypting log data.

To associate an AWS 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 . For more information, see Encrypt log data in CloudWatch Logs using AWS Key Management Service

Parameters:

kmsKeyId - The Amazon Resource Name (ARN) of the AWS key to use when encrypting log data. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-kmskeyid

kmsKeyId

@Stability(Stable)
public CfnLogGroupPropsMixin.Builder kmsKeyId(IKeyRef kmsKeyId)

The Amazon Resource Name (ARN) of the AWS key to use when encrypting log data.

To associate an AWS 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 . For more information, see Encrypt log data in CloudWatch Logs using AWS Key Management Service

Parameters:

kmsKeyId - The Amazon Resource Name (ARN) of the AWS key to use when encrypting log data. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-kmskeyid

logGroupClass

@Stability(Stable)
public CfnLogGroupPropsMixin.Builder logGroupClass(String logGroupClass)

Specifies the log group class for this log group. There are two classes:.

• The Standard log class supports all CloudWatch Logs features.
• The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.

For details about the features supported by each class, see Log classes

Default: - "STANDARD"

Parameters:

logGroupClass - Specifies the log group class for this log group. There are two classes:. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-loggroupclass

logGroupName

@Stability(Stable)
public CfnLogGroupPropsMixin.Builder logGroupName(String logGroupName)

The name of the log group.

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

Parameters:

logGroupName - The name of the log group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-loggroupname

logGroupName

@Stability(Stable)
public CfnLogGroupPropsMixin.Builder logGroupName(IFunctionRef logGroupName)

The name of the log group.

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

Parameters:

logGroupName - The name of the log group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-loggroupname

resourcePolicyDocument

@Stability(Stable)
public CfnLogGroupPropsMixin.Builder resourcePolicyDocument(Object resourcePolicyDocument)

Creates or updates a resource policy for the specified log group that allows other services to put log events to this account.

A LogGroup can have 1 resource policy.

Parameters:

resourcePolicyDocument - Creates or updates a resource policy for the specified log group that allows other services to put log events to this account. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-resourcepolicydocument

retentionInDays

@Stability(Stable)
public CfnLogGroupPropsMixin.Builder retentionInDays(Number 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, 1096, 1827, 2192, 2557, 2922, 3288, and 3653.

To set a log group so that its log events do not expire, do not specify this property.

Parameters:

retentionInDays - The number of days to retain the log events in the specified log group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-retentionindays

tags

@Stability(Stable)
public CfnLogGroupPropsMixin.Builder tags(List<? extends CfnTag> tags)

An array of key-value pairs to apply to the log group.

For more information, see Tag .

Parameters:

tags - An array of key-value pairs to apply to the log group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-tags

build

@Stability(Stable)
public CfnLogGroupPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnLogGroupPropsMixin.