Class EnableLoggingRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<EnableLoggingRequest.Builder,
EnableLoggingRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The name of an existing S3 bucket where the log files are to be stored.static EnableLoggingRequest.Builder
builder()
final String
The identifier of the cluster on which logging is to be started.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
For responses, this returns true if the service returned a value for the LogExports property.final LogDestinationType
The log destination type.final String
The log destination type.The collection of exported log types.final String
The prefix applied to the log file names.static Class
<? extends EnableLoggingRequest.Builder> 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
-
clusterIdentifier
The identifier of the cluster on which logging is to be started.
Example:
examplecluster
- Returns:
- The identifier of the cluster on which logging is to be started.
Example:
examplecluster
-
bucketName
The name of an existing S3 bucket where the log files are to be stored.
Constraints:
-
Must be in the same region as the cluster
-
The cluster must have read bucket and put object permissions
- Returns:
- The name of an existing S3 bucket where the log files are to be stored.
Constraints:
-
Must be in the same region as the cluster
-
The cluster must have read bucket and put object permissions
-
-
-
s3KeyPrefix
The prefix applied to the log file names.
Constraints:
-
Cannot exceed 512 characters
-
Cannot contain spaces( ), double quotes ("), single quotes ('), a backslash (\), or control characters. The hexadecimal codes for invalid characters are:
-
x00 to x20
-
x22
-
x27
-
x5c
-
x7f or larger
-
- Returns:
- The prefix applied to the log file names.
Constraints:
-
Cannot exceed 512 characters
-
Cannot contain spaces( ), double quotes ("), single quotes ('), a backslash (\), or control characters. The hexadecimal codes for invalid characters are:
-
x00 to x20
-
x22
-
x27
-
x5c
-
x7f or larger
-
-
-
-
logDestinationType
The log destination type. An enum with possible values of
s3
andcloudwatch
.If the service returns an enum value that is not available in the current SDK version,
logDestinationType
will returnLogDestinationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlogDestinationTypeAsString()
.- Returns:
- The log destination type. An enum with possible values of
s3
andcloudwatch
. - See Also:
-
logDestinationTypeAsString
The log destination type. An enum with possible values of
s3
andcloudwatch
.If the service returns an enum value that is not available in the current SDK version,
logDestinationType
will returnLogDestinationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlogDestinationTypeAsString()
.- Returns:
- The log destination type. An enum with possible values of
s3
andcloudwatch
. - See Also:
-
hasLogExports
public final boolean hasLogExports()For responses, this returns true if the service returned a value for the LogExports 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. -
logExports
The collection of exported log types. Possible values are
connectionlog
,useractivitylog
, anduserlog
.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
hasLogExports()
method.- Returns:
- The collection of exported log types. Possible values are
connectionlog
,useractivitylog
, anduserlog
.
-
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<EnableLoggingRequest.Builder,
EnableLoggingRequest> - Specified by:
toBuilder
in classRedshiftRequest
- 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
-