Class CreateLogGroupRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsRequest
-
- software.amazon.awssdk.services.cloudwatchlogs.model.CreateLogGroupRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateLogGroupRequest.Builder,CreateLogGroupRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateLogGroupRequest extends CloudWatchLogsRequest implements ToCopyableBuilder<CreateLogGroupRequest.Builder,CreateLogGroupRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateLogGroupRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateLogGroupRequest.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.StringkmsKeyId()The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.LogGroupClasslogGroupClass()Use this parameter to specify the log group class for this log group.StringlogGroupClassAsString()Use this parameter to specify the log group class for this log group.StringlogGroupName()A name for the log group.List<SdkField<?>>sdkFields()static Class<? extends CreateLogGroupRequest.Builder>serializableBuilderClass()Map<String,String>tags()The key-value pairs to use for the tags.CreateLogGroupRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
logGroupName
public final String logGroupName()
A name for the log group.
- Returns:
- A name for the log group.
-
kmsKeyId
public final String kmsKeyId()
The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. For more information, see Amazon Resource Names.
- Returns:
- The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. For more information, see Amazon Resource Names.
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
tags
public final Map<String,String> tags()
The key-value pairs to use for the tags.
You can grant users access to certain log groups while preventing them from accessing other log groups. To do so, tag your groups and use IAM policies that refer to those tags. To assign tags when you create a log group, you must have either the
logs:TagResourceorlogs:TagLogGrouppermission. For more information about tagging, see Tagging Amazon Web Services resources. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()method.- Returns:
- The key-value pairs to use for the tags.
You can grant users access to certain log groups while preventing them from accessing other log groups. To do so, tag your groups and use IAM policies that refer to those tags. To assign tags when you create a log group, you must have either the
logs:TagResourceorlogs:TagLogGrouppermission. For more information about tagging, see Tagging Amazon Web Services resources. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.
-
logGroupClass
public final LogGroupClass logGroupClass()
Use this parameter to specify the log group class for this log group. There are two classes:
-
The
Standardlog class supports all CloudWatch Logs features. -
The
Infrequent Accesslog class supports a subset of CloudWatch Logs features and incurs lower costs.
If you omit this parameter, the default of
STANDARDis used.The value of
logGroupClasscan't be changed after a log group is created.For details about the features supported by each class, see Log classes
If the service returns an enum value that is not available in the current SDK version,
logGroupClasswill returnLogGroupClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlogGroupClassAsString().- Returns:
- Use this parameter to specify the log group class for this log group. There are two classes:
-
The
Standardlog class supports all CloudWatch Logs features. -
The
Infrequent Accesslog class supports a subset of CloudWatch Logs features and incurs lower costs.
If you omit this parameter, the default of
STANDARDis used.The value of
logGroupClasscan't be changed after a log group is created.For details about the features supported by each class, see Log classes
-
- See Also:
LogGroupClass
-
-
logGroupClassAsString
public final String logGroupClassAsString()
Use this parameter to specify the log group class for this log group. There are two classes:
-
The
Standardlog class supports all CloudWatch Logs features. -
The
Infrequent Accesslog class supports a subset of CloudWatch Logs features and incurs lower costs.
If you omit this parameter, the default of
STANDARDis used.The value of
logGroupClasscan't be changed after a log group is created.For details about the features supported by each class, see Log classes
If the service returns an enum value that is not available in the current SDK version,
logGroupClasswill returnLogGroupClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlogGroupClassAsString().- Returns:
- Use this parameter to specify the log group class for this log group. There are two classes:
-
The
Standardlog class supports all CloudWatch Logs features. -
The
Infrequent Accesslog class supports a subset of CloudWatch Logs features and incurs lower costs.
If you omit this parameter, the default of
STANDARDis used.The value of
logGroupClasscan't be changed after a log group is created.For details about the features supported by each class, see Log classes
-
- See Also:
LogGroupClass
-
-
toBuilder
public CreateLogGroupRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateLogGroupRequest.Builder,CreateLogGroupRequest>- Specified by:
toBuilderin classCloudWatchLogsRequest
-
builder
public static CreateLogGroupRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateLogGroupRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-