com.amazonaws.services.fsx.model.LustreLogCreateConfiguration Maven / Gradle / Ivy
Show all versions of aws-java-sdk-fsx Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.fsx.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The Lustre logging configuration used when creating or updating an Amazon FSx for Lustre file system. An Amazon File
* Cache is created with Lustre logging enabled by default, with a setting of WARN_ERROR for the logging
* events. which can't be changed.
*
*
* Lustre logging writes the enabled logging events for your file system or cache to Amazon CloudWatch Logs.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class LustreLogCreateConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* Sets which data repository events are logged by Amazon FSx.
*
*
* -
*
* WARN_ONLY - only warning events are logged.
*
*
* -
*
* ERROR_ONLY - only error events are logged.
*
*
* -
*
* WARN_ERROR - both warning events and error events are logged.
*
*
* -
*
* DISABLED - logging of data repository events is turned off.
*
*
*
*/
private String level;
/**
*
* The Amazon Resource Name (ARN) that specifies the destination of the logs.
*
*
* The destination can be any Amazon CloudWatch Logs log group ARN, with the following requirements:
*
*
* -
*
* The destination ARN that you provide must be in the same Amazon Web Services partition, Amazon Web Services
* Region, and Amazon Web Services account as your Amazon FSx file system.
*
*
* -
*
* The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix.
*
*
* -
*
* If you do not provide a destination, Amazon FSx will create and use a log stream in the CloudWatch Logs
* /aws/fsx/lustre log group (for Amazon FSx for Lustre) or /aws/fsx/filecache (for Amazon
* File Cache).
*
*
* -
*
* If Destination is provided and the resource does not exist, the request will fail with a
* BadRequest error.
*
*
* -
*
* If Level is set to DISABLED, you cannot specify a destination in
* Destination.
*
*
*
*/
private String destination;
/**
*
* Sets which data repository events are logged by Amazon FSx.
*
*
* -
*
* WARN_ONLY - only warning events are logged.
*
*
* -
*
* ERROR_ONLY - only error events are logged.
*
*
* -
*
* WARN_ERROR - both warning events and error events are logged.
*
*
* -
*
* DISABLED - logging of data repository events is turned off.
*
*
*
*
* @param level
* Sets which data repository events are logged by Amazon FSx.
*
* -
*
* WARN_ONLY - only warning events are logged.
*
*
* -
*
* ERROR_ONLY - only error events are logged.
*
*
* -
*
* WARN_ERROR - both warning events and error events are logged.
*
*
* -
*
* DISABLED - logging of data repository events is turned off.
*
*
* @see LustreAccessAuditLogLevel
*/
public void setLevel(String level) {
this.level = level;
}
/**
*
* Sets which data repository events are logged by Amazon FSx.
*
*
* -
*
* WARN_ONLY - only warning events are logged.
*
*
* -
*
* ERROR_ONLY - only error events are logged.
*
*
* -
*
* WARN_ERROR - both warning events and error events are logged.
*
*
* -
*
* DISABLED - logging of data repository events is turned off.
*
*
*
*
* @return Sets which data repository events are logged by Amazon FSx.
*
* -
*
* WARN_ONLY - only warning events are logged.
*
*
* -
*
* ERROR_ONLY - only error events are logged.
*
*
* -
*
* WARN_ERROR - both warning events and error events are logged.
*
*
* -
*
* DISABLED - logging of data repository events is turned off.
*
*
* @see LustreAccessAuditLogLevel
*/
public String getLevel() {
return this.level;
}
/**
*
* Sets which data repository events are logged by Amazon FSx.
*
*
* -
*
* WARN_ONLY - only warning events are logged.
*
*
* -
*
* ERROR_ONLY - only error events are logged.
*
*
* -
*
* WARN_ERROR - both warning events and error events are logged.
*
*
* -
*
* DISABLED - logging of data repository events is turned off.
*
*
*
*
* @param level
* Sets which data repository events are logged by Amazon FSx.
*
* -
*
* WARN_ONLY - only warning events are logged.
*
*
* -
*
* ERROR_ONLY - only error events are logged.
*
*
* -
*
* WARN_ERROR - both warning events and error events are logged.
*
*
* -
*
* DISABLED - logging of data repository events is turned off.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see LustreAccessAuditLogLevel
*/
public LustreLogCreateConfiguration withLevel(String level) {
setLevel(level);
return this;
}
/**
*
* Sets which data repository events are logged by Amazon FSx.
*
*
* -
*
* WARN_ONLY - only warning events are logged.
*
*
* -
*
* ERROR_ONLY - only error events are logged.
*
*
* -
*
* WARN_ERROR - both warning events and error events are logged.
*
*
* -
*
* DISABLED - logging of data repository events is turned off.
*
*
*
*
* @param level
* Sets which data repository events are logged by Amazon FSx.
*
* -
*
* WARN_ONLY - only warning events are logged.
*
*
* -
*
* ERROR_ONLY - only error events are logged.
*
*
* -
*
* WARN_ERROR - both warning events and error events are logged.
*
*
* -
*
* DISABLED - logging of data repository events is turned off.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see LustreAccessAuditLogLevel
*/
public LustreLogCreateConfiguration withLevel(LustreAccessAuditLogLevel level) {
this.level = level.toString();
return this;
}
/**
*
* The Amazon Resource Name (ARN) that specifies the destination of the logs.
*
*
* The destination can be any Amazon CloudWatch Logs log group ARN, with the following requirements:
*
*
* -
*
* The destination ARN that you provide must be in the same Amazon Web Services partition, Amazon Web Services
* Region, and Amazon Web Services account as your Amazon FSx file system.
*
*
* -
*
* The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix.
*
*
* -
*
* If you do not provide a destination, Amazon FSx will create and use a log stream in the CloudWatch Logs
* /aws/fsx/lustre log group (for Amazon FSx for Lustre) or /aws/fsx/filecache (for Amazon
* File Cache).
*
*
* -
*
* If Destination is provided and the resource does not exist, the request will fail with a
* BadRequest error.
*
*
* -
*
* If Level is set to DISABLED, you cannot specify a destination in
* Destination.
*
*
*
*
* @param destination
* The Amazon Resource Name (ARN) that specifies the destination of the logs.
*
* The destination can be any Amazon CloudWatch Logs log group ARN, with the following requirements:
*
*
* -
*
* The destination ARN that you provide must be in the same Amazon Web Services partition, Amazon Web
* Services Region, and Amazon Web Services account as your Amazon FSx file system.
*
*
* -
*
* The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix.
*
*
* -
*
* If you do not provide a destination, Amazon FSx will create and use a log stream in the CloudWatch Logs
* /aws/fsx/lustre log group (for Amazon FSx for Lustre) or /aws/fsx/filecache (for
* Amazon File Cache).
*
*
* -
*
* If Destination is provided and the resource does not exist, the request will fail with a
* BadRequest error.
*
*
* -
*
* If Level is set to DISABLED, you cannot specify a destination in
* Destination.
*
*
*/
public void setDestination(String destination) {
this.destination = destination;
}
/**
*
* The Amazon Resource Name (ARN) that specifies the destination of the logs.
*
*
* The destination can be any Amazon CloudWatch Logs log group ARN, with the following requirements:
*
*
* -
*
* The destination ARN that you provide must be in the same Amazon Web Services partition, Amazon Web Services
* Region, and Amazon Web Services account as your Amazon FSx file system.
*
*
* -
*
* The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix.
*
*
* -
*
* If you do not provide a destination, Amazon FSx will create and use a log stream in the CloudWatch Logs
* /aws/fsx/lustre log group (for Amazon FSx for Lustre) or /aws/fsx/filecache (for Amazon
* File Cache).
*
*
* -
*
* If Destination is provided and the resource does not exist, the request will fail with a
* BadRequest error.
*
*
* -
*
* If Level is set to DISABLED, you cannot specify a destination in
* Destination.
*
*
*
*
* @return The Amazon Resource Name (ARN) that specifies the destination of the logs.
*
* The destination can be any Amazon CloudWatch Logs log group ARN, with the following requirements:
*
*
* -
*
* The destination ARN that you provide must be in the same Amazon Web Services partition, Amazon Web
* Services Region, and Amazon Web Services account as your Amazon FSx file system.
*
*
* -
*
* The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix.
*
*
* -
*
* If you do not provide a destination, Amazon FSx will create and use a log stream in the CloudWatch Logs
* /aws/fsx/lustre log group (for Amazon FSx for Lustre) or /aws/fsx/filecache
* (for Amazon File Cache).
*
*
* -
*
* If Destination is provided and the resource does not exist, the request will fail with a
* BadRequest error.
*
*
* -
*
* If Level is set to DISABLED, you cannot specify a destination in
* Destination.
*
*
*/
public String getDestination() {
return this.destination;
}
/**
*
* The Amazon Resource Name (ARN) that specifies the destination of the logs.
*
*
* The destination can be any Amazon CloudWatch Logs log group ARN, with the following requirements:
*
*
* -
*
* The destination ARN that you provide must be in the same Amazon Web Services partition, Amazon Web Services
* Region, and Amazon Web Services account as your Amazon FSx file system.
*
*
* -
*
* The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix.
*
*
* -
*
* If you do not provide a destination, Amazon FSx will create and use a log stream in the CloudWatch Logs
* /aws/fsx/lustre log group (for Amazon FSx for Lustre) or /aws/fsx/filecache (for Amazon
* File Cache).
*
*
* -
*
* If Destination is provided and the resource does not exist, the request will fail with a
* BadRequest error.
*
*
* -
*
* If Level is set to DISABLED, you cannot specify a destination in
* Destination.
*
*
*
*
* @param destination
* The Amazon Resource Name (ARN) that specifies the destination of the logs.
*
* The destination can be any Amazon CloudWatch Logs log group ARN, with the following requirements:
*
*
* -
*
* The destination ARN that you provide must be in the same Amazon Web Services partition, Amazon Web
* Services Region, and Amazon Web Services account as your Amazon FSx file system.
*
*
* -
*
* The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix.
*
*
* -
*
* If you do not provide a destination, Amazon FSx will create and use a log stream in the CloudWatch Logs
* /aws/fsx/lustre log group (for Amazon FSx for Lustre) or /aws/fsx/filecache (for
* Amazon File Cache).
*
*
* -
*
* If Destination is provided and the resource does not exist, the request will fail with a
* BadRequest error.
*
*
* -
*
* If Level is set to DISABLED, you cannot specify a destination in
* Destination.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public LustreLogCreateConfiguration withDestination(String destination) {
setDestination(destination);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getLevel() != null)
sb.append("Level: ").append(getLevel()).append(",");
if (getDestination() != null)
sb.append("Destination: ").append(getDestination());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof LustreLogCreateConfiguration == false)
return false;
LustreLogCreateConfiguration other = (LustreLogCreateConfiguration) obj;
if (other.getLevel() == null ^ this.getLevel() == null)
return false;
if (other.getLevel() != null && other.getLevel().equals(this.getLevel()) == false)
return false;
if (other.getDestination() == null ^ this.getDestination() == null)
return false;
if (other.getDestination() != null && other.getDestination().equals(this.getDestination()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getLevel() == null) ? 0 : getLevel().hashCode());
hashCode = prime * hashCode + ((getDestination() == null) ? 0 : getDestination().hashCode());
return hashCode;
}
@Override
public LustreLogCreateConfiguration clone() {
try {
return (LustreLogCreateConfiguration) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.fsx.model.transform.LustreLogCreateConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}