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

Class CfnLogGroupMixinProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.logs.CfnLogGroupMixinProps.Jsii$Proxy

All Implemented Interfaces:

CfnLogGroupMixinProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnLogGroupMixinProps

@Stability(Stable)
@Internal
public static final class CfnLogGroupMixinProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnLogGroupMixinProps

An implementation for CfnLogGroupMixinProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.cfnpropertymixins.services.logs.CfnLogGroupMixinProps

CfnLogGroupMixinProps.Builder, CfnLogGroupMixinProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnLogGroupMixinProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnLogGroupMixinProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getDataProtectionPolicy()	Creates a data protection policy and assigns it to the log group.
final Object	getDeletionProtectionEnabled()	Indicates whether deletion protection is enabled for this log group.
final Object	getFieldIndexPolicies()	Creates or updates a field index policy for the specified log group.
final Object	getKmsKeyId()	The Amazon Resource Name (ARN) of the AWS key to use when encrypting log data.
final String	getLogGroupClass()	Specifies the log group class for this log group.
final Object	getLogGroupName()	The name of the log group.
final Object	getResourcePolicyDocument()	Creates or updates a resource policy for the specified log group that allows other services to put log events to this account.
final Number	getRetentionInDays()	The number of days to retain the log events in the specified log group.
final List<CfnTag>	getTags()	An array of key-value pairs to apply to the log group.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnLogGroupMixinProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnLogGroupMixinProps.Builder.

Method Details

getDataProtectionPolicy

public final Object getDataProtectionPolicy()

Description copied from interface: CfnLogGroupMixinProps

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.

Specified by:

getDataProtectionPolicy in interface CfnLogGroupMixinProps

See Also:

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

getDeletionProtectionEnabled

public final Object getDeletionProtectionEnabled()

Description copied from interface: CfnLogGroupMixinProps

Indicates whether deletion protection is enabled for this log group.

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

Returns union: either Boolean or IResolvable

Default: - false

Specified by:

getDeletionProtectionEnabled in interface CfnLogGroupMixinProps

See Also:

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

getFieldIndexPolicies

public final Object getFieldIndexPolicies()

Description copied from interface: CfnLogGroupMixinProps

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.

Returns union: either Listinvalid input: '<'Object> or IResolvable

Specified by:

getFieldIndexPolicies in interface CfnLogGroupMixinProps

See Also:

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

getKmsKeyId

public final Object getKmsKeyId()

Description copied from interface: CfnLogGroupMixinProps

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

Returns union: either String or IKeyRef

Specified by:

getKmsKeyId in interface CfnLogGroupMixinProps

See Also:

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

getLogGroupClass

public final String getLogGroupClass()

Description copied from interface: CfnLogGroupMixinProps

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"

Specified by:

getLogGroupClass in interface CfnLogGroupMixinProps

See Also:

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

getLogGroupName

public final Object getLogGroupName()

Description copied from interface: CfnLogGroupMixinProps

The name of the log group.

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

Returns union: either String or IFunctionRef

Specified by:

getLogGroupName in interface CfnLogGroupMixinProps

See Also:

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

getResourcePolicyDocument

public final Object getResourcePolicyDocument()

Description copied from interface: CfnLogGroupMixinProps

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.

Specified by:

getResourcePolicyDocument in interface CfnLogGroupMixinProps

See Also:

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

getRetentionInDays

public final Number getRetentionInDays()

Description copied from interface: CfnLogGroupMixinProps

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.

Specified by:

getRetentionInDays in interface CfnLogGroupMixinProps

See Also:

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

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnLogGroupMixinProps

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

For more information, see Tag .

Specified by:

getTags in interface CfnLogGroupMixinProps

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object