Class CreateLogGroupRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateLogGroupRequest.Builder,
CreateLogGroupRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
kmsKeyId()
The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.final LogGroupClass
Use this parameter to specify the log group class for this log group.final String
Use this parameter to specify the log group class for this log group.final String
A name for the log group.static Class
<? extends CreateLogGroupRequest.Builder> tags()
The key-value pairs to use for the tags.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
logGroupName
A name for the log group.
- Returns:
- A name for the log group.
-
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
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:TagResource
orlogs:TagLogGroup
permission. 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:TagResource
orlogs:TagLogGroup
permission. 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
Use this parameter to specify 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.
If you omit this parameter, the default of
STANDARD
is used.The value of
logGroupClass
can'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,
logGroupClass
will 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
Standard
log class supports all CloudWatch Logs features. -
The
Infrequent Access
log class supports a subset of CloudWatch Logs features and incurs lower costs.
If you omit this parameter, the default of
STANDARD
is used.The value of
logGroupClass
can't be changed after a log group is created.For details about the features supported by each class, see Log classes
-
- See Also:
-
-
logGroupClassAsString
Use this parameter to specify 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.
If you omit this parameter, the default of
STANDARD
is used.The value of
logGroupClass
can'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,
logGroupClass
will 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
Standard
log class supports all CloudWatch Logs features. -
The
Infrequent Access
log class supports a subset of CloudWatch Logs features and incurs lower costs.
If you omit this parameter, the default of
STANDARD
is used.The value of
logGroupClass
can't be changed after a log group is created.For details about the features supported by each class, see Log classes
-
- See Also:
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateLogGroupRequest.Builder,
CreateLogGroupRequest> - Specified by:
toBuilder
in classCloudWatchLogsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-