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

Class CfnLogGroupMixinProps.Builder

java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.logs.CfnLogGroupMixinProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnLogGroupMixinProps>
Enclosing interface:
CfnLogGroupMixinProps
@Stability(Stable) public static final class CfnLogGroupMixinProps.Builder extends Object implements software.amazon.jsii.Builder<CfnLogGroupMixinProps>
A builder for CfnLogGroupMixinProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • dataProtectionPolicy

      @Stability(Stable) public CfnLogGroupMixinProps.Builder dataProtectionPolicy(Object dataProtectionPolicy)
      Sets the value of CfnLogGroupMixinProps.getDataProtectionPolicy()
      Parameters:
      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.
      Returns:
      this

    • deletionProtectionEnabled

      @Stability(Stable) public CfnLogGroupMixinProps.Builder deletionProtectionEnabled(Boolean deletionProtectionEnabled)
      Sets the value of CfnLogGroupMixinProps.getDeletionProtectionEnabled()
      Parameters:
      deletionProtectionEnabled - Indicates whether deletion protection is enabled for this log group. When enabled, deletion protection blocks all deletion operations until it is explicitly disabled.
      Returns:
      this

    • deletionProtectionEnabled

      @Stability(Stable) public CfnLogGroupMixinProps.Builder deletionProtectionEnabled(IResolvable deletionProtectionEnabled)
      Sets the value of CfnLogGroupMixinProps.getDeletionProtectionEnabled()
      Parameters:
      deletionProtectionEnabled - Indicates whether deletion protection is enabled for this log group. When enabled, deletion protection blocks all deletion operations until it is explicitly disabled.
      Returns:
      this

    • fieldIndexPolicies

      @Stability(Stable) public CfnLogGroupMixinProps.Builder fieldIndexPolicies(List<? extends Object> fieldIndexPolicies)
      Sets the value of CfnLogGroupMixinProps.getFieldIndexPolicies()
      Parameters:
      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.

      Returns:
      this

    • fieldIndexPolicies

      @Stability(Stable) public CfnLogGroupMixinProps.Builder fieldIndexPolicies(IResolvable fieldIndexPolicies)
      Sets the value of CfnLogGroupMixinProps.getFieldIndexPolicies()
      Parameters:
      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.

      Returns:
      this

    • kmsKeyId

      @Stability(Stable) public CfnLogGroupMixinProps.Builder kmsKeyId(String kmsKeyId)
      Sets the value of CfnLogGroupMixinProps.getKmsKeyId()
      Parameters:
      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

      Returns:
      this

    • kmsKeyId

      @Stability(Stable) public CfnLogGroupMixinProps.Builder kmsKeyId(IKeyRef kmsKeyId)
      Sets the value of CfnLogGroupMixinProps.getKmsKeyId()
      Parameters:
      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

      Returns:
      this

    • logGroupClass

      @Stability(Stable) public CfnLogGroupMixinProps.Builder logGroupClass(String logGroupClass)
      Sets the value of CfnLogGroupMixinProps.getLogGroupClass()
      Parameters:
      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

      Returns:
      this

    • logGroupName

      @Stability(Stable) public CfnLogGroupMixinProps.Builder logGroupName(String logGroupName)
      Sets the value of CfnLogGroupMixinProps.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

    • logGroupName

      @Stability(Stable) public CfnLogGroupMixinProps.Builder logGroupName(IFunctionRef logGroupName)
      Sets the value of CfnLogGroupMixinProps.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

    • resourcePolicyDocument

      @Stability(Stable) public CfnLogGroupMixinProps.Builder resourcePolicyDocument(Object resourcePolicyDocument)
      Sets the value of CfnLogGroupMixinProps.getResourcePolicyDocument()
      Parameters:
      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.
      Returns:
      this

    • retentionInDays

      @Stability(Stable) public CfnLogGroupMixinProps.Builder retentionInDays(Number retentionInDays)
      Sets the value of CfnLogGroupMixinProps.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, 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.

      Returns:
      this

    • tags

      @Stability(Stable) public CfnLogGroupMixinProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnLogGroupMixinProps.getTags()
      Parameters:
      tags - An array of key-value pairs to apply to the log group. For more information, see Tag .
      Returns:
      this

    • build

      @Stability(Stable) public CfnLogGroupMixinProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnLogGroupMixinProps>
      Returns:
      a new instance of CfnLogGroupMixinProps
      Throws:
      NullPointerException - if any required attribute was not provided