com.amazonaws.services.config.model.SourceDetail Maven / Gradle / Ivy
/*
* 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.config.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Provides the source and the message types that trigger Config to evaluate your Amazon Web Services resources against
* a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type
* is periodic. You can specify the parameter values for SourceDetail only for custom rules.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SourceDetail implements Serializable, Cloneable, StructuredPojo {
/**
*
* The source of the event, such as an Amazon Web Services service, that triggers Config to evaluate your Amazon Web
* Services resources.
*
*/
private String eventSource;
/**
*
* The type of notification that triggers Config to run an evaluation for a rule. You can specify the following
* notification types:
*
*
* -
*
* ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a configuration
* item as a result of a resource change.
*
*
* -
*
* OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an
* oversized configuration item. Config may generate this notification type when a resource changes and the
* notification exceeds the maximum size allowed by Amazon SNS.
*
*
* -
*
* ScheduledNotification - Triggers a periodic evaluation at the frequency specified for
* MaximumExecutionFrequency.
*
*
* -
*
* ConfigurationSnapshotDeliveryCompleted - Triggers a periodic evaluation when Config delivers a
* configuration snapshot.
*
*
*
*
* If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for
* ConfigurationItemChangeNotification and one for
* OversizedConfigurationItemChangeNotification.
*
*/
private String messageType;
/**
*
* The frequency at which you want Config to run evaluations for a custom rule with a periodic trigger. If you
* specify a value for MaximumExecutionFrequency, then MessageType must use the
* ScheduledNotification value.
*
*
*
* By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid
* value for the MaximumExecutionFrequency parameter.
*
*
* Based on the valid value you choose, Config runs evaluations once for each valid value. For example, if you
* choose Three_Hours, Config runs evaluations once every three hours. In this case,
* Three_Hours is the frequency of this rule.
*
*
*/
private String maximumExecutionFrequency;
/**
*
* The source of the event, such as an Amazon Web Services service, that triggers Config to evaluate your Amazon Web
* Services resources.
*
*
* @param eventSource
* The source of the event, such as an Amazon Web Services service, that triggers Config to evaluate your
* Amazon Web Services resources.
* @see EventSource
*/
public void setEventSource(String eventSource) {
this.eventSource = eventSource;
}
/**
*
* The source of the event, such as an Amazon Web Services service, that triggers Config to evaluate your Amazon Web
* Services resources.
*
*
* @return The source of the event, such as an Amazon Web Services service, that triggers Config to evaluate your
* Amazon Web Services resources.
* @see EventSource
*/
public String getEventSource() {
return this.eventSource;
}
/**
*
* The source of the event, such as an Amazon Web Services service, that triggers Config to evaluate your Amazon Web
* Services resources.
*
*
* @param eventSource
* The source of the event, such as an Amazon Web Services service, that triggers Config to evaluate your
* Amazon Web Services resources.
* @return Returns a reference to this object so that method calls can be chained together.
* @see EventSource
*/
public SourceDetail withEventSource(String eventSource) {
setEventSource(eventSource);
return this;
}
/**
*
* The source of the event, such as an Amazon Web Services service, that triggers Config to evaluate your Amazon Web
* Services resources.
*
*
* @param eventSource
* The source of the event, such as an Amazon Web Services service, that triggers Config to evaluate your
* Amazon Web Services resources.
* @see EventSource
*/
public void setEventSource(EventSource eventSource) {
withEventSource(eventSource);
}
/**
*
* The source of the event, such as an Amazon Web Services service, that triggers Config to evaluate your Amazon Web
* Services resources.
*
*
* @param eventSource
* The source of the event, such as an Amazon Web Services service, that triggers Config to evaluate your
* Amazon Web Services resources.
* @return Returns a reference to this object so that method calls can be chained together.
* @see EventSource
*/
public SourceDetail withEventSource(EventSource eventSource) {
this.eventSource = eventSource.toString();
return this;
}
/**
*
* The type of notification that triggers Config to run an evaluation for a rule. You can specify the following
* notification types:
*
*
* -
*
* ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a configuration
* item as a result of a resource change.
*
*
* -
*
* OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an
* oversized configuration item. Config may generate this notification type when a resource changes and the
* notification exceeds the maximum size allowed by Amazon SNS.
*
*
* -
*
* ScheduledNotification - Triggers a periodic evaluation at the frequency specified for
* MaximumExecutionFrequency.
*
*
* -
*
* ConfigurationSnapshotDeliveryCompleted - Triggers a periodic evaluation when Config delivers a
* configuration snapshot.
*
*
*
*
* If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for
* ConfigurationItemChangeNotification and one for
* OversizedConfigurationItemChangeNotification.
*
*
* @param messageType
* The type of notification that triggers Config to run an evaluation for a rule. You can specify the
* following notification types:
*
* -
*
* ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a
* configuration item as a result of a resource change.
*
*
* -
*
* OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an
* oversized configuration item. Config may generate this notification type when a resource changes and the
* notification exceeds the maximum size allowed by Amazon SNS.
*
*
* -
*
* ScheduledNotification - Triggers a periodic evaluation at the frequency specified for
* MaximumExecutionFrequency.
*
*
* -
*
* ConfigurationSnapshotDeliveryCompleted - Triggers a periodic evaluation when Config delivers
* a configuration snapshot.
*
*
*
*
* If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects,
* one for ConfigurationItemChangeNotification and one for
* OversizedConfigurationItemChangeNotification.
* @see MessageType
*/
public void setMessageType(String messageType) {
this.messageType = messageType;
}
/**
*
* The type of notification that triggers Config to run an evaluation for a rule. You can specify the following
* notification types:
*
*
* -
*
* ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a configuration
* item as a result of a resource change.
*
*
* -
*
* OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an
* oversized configuration item. Config may generate this notification type when a resource changes and the
* notification exceeds the maximum size allowed by Amazon SNS.
*
*
* -
*
* ScheduledNotification - Triggers a periodic evaluation at the frequency specified for
* MaximumExecutionFrequency.
*
*
* -
*
* ConfigurationSnapshotDeliveryCompleted - Triggers a periodic evaluation when Config delivers a
* configuration snapshot.
*
*
*
*
* If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for
* ConfigurationItemChangeNotification and one for
* OversizedConfigurationItemChangeNotification.
*
*
* @return The type of notification that triggers Config to run an evaluation for a rule. You can specify the
* following notification types:
*
* -
*
* ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a
* configuration item as a result of a resource change.
*
*
* -
*
* OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers
* an oversized configuration item. Config may generate this notification type when a resource changes and
* the notification exceeds the maximum size allowed by Amazon SNS.
*
*
* -
*
* ScheduledNotification - Triggers a periodic evaluation at the frequency specified for
* MaximumExecutionFrequency.
*
*
* -
*
* ConfigurationSnapshotDeliveryCompleted - Triggers a periodic evaluation when Config delivers
* a configuration snapshot.
*
*
*
*
* If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects,
* one for ConfigurationItemChangeNotification and one for
* OversizedConfigurationItemChangeNotification.
* @see MessageType
*/
public String getMessageType() {
return this.messageType;
}
/**
*
* The type of notification that triggers Config to run an evaluation for a rule. You can specify the following
* notification types:
*
*
* -
*
* ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a configuration
* item as a result of a resource change.
*
*
* -
*
* OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an
* oversized configuration item. Config may generate this notification type when a resource changes and the
* notification exceeds the maximum size allowed by Amazon SNS.
*
*
* -
*
* ScheduledNotification - Triggers a periodic evaluation at the frequency specified for
* MaximumExecutionFrequency.
*
*
* -
*
* ConfigurationSnapshotDeliveryCompleted - Triggers a periodic evaluation when Config delivers a
* configuration snapshot.
*
*
*
*
* If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for
* ConfigurationItemChangeNotification and one for
* OversizedConfigurationItemChangeNotification.
*
*
* @param messageType
* The type of notification that triggers Config to run an evaluation for a rule. You can specify the
* following notification types:
*
* -
*
* ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a
* configuration item as a result of a resource change.
*
*
* -
*
* OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an
* oversized configuration item. Config may generate this notification type when a resource changes and the
* notification exceeds the maximum size allowed by Amazon SNS.
*
*
* -
*
* ScheduledNotification - Triggers a periodic evaluation at the frequency specified for
* MaximumExecutionFrequency.
*
*
* -
*
* ConfigurationSnapshotDeliveryCompleted - Triggers a periodic evaluation when Config delivers
* a configuration snapshot.
*
*
*
*
* If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects,
* one for ConfigurationItemChangeNotification and one for
* OversizedConfigurationItemChangeNotification.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MessageType
*/
public SourceDetail withMessageType(String messageType) {
setMessageType(messageType);
return this;
}
/**
*
* The type of notification that triggers Config to run an evaluation for a rule. You can specify the following
* notification types:
*
*
* -
*
* ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a configuration
* item as a result of a resource change.
*
*
* -
*
* OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an
* oversized configuration item. Config may generate this notification type when a resource changes and the
* notification exceeds the maximum size allowed by Amazon SNS.
*
*
* -
*
* ScheduledNotification - Triggers a periodic evaluation at the frequency specified for
* MaximumExecutionFrequency.
*
*
* -
*
* ConfigurationSnapshotDeliveryCompleted - Triggers a periodic evaluation when Config delivers a
* configuration snapshot.
*
*
*
*
* If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for
* ConfigurationItemChangeNotification and one for
* OversizedConfigurationItemChangeNotification.
*
*
* @param messageType
* The type of notification that triggers Config to run an evaluation for a rule. You can specify the
* following notification types:
*
* -
*
* ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a
* configuration item as a result of a resource change.
*
*
* -
*
* OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an
* oversized configuration item. Config may generate this notification type when a resource changes and the
* notification exceeds the maximum size allowed by Amazon SNS.
*
*
* -
*
* ScheduledNotification - Triggers a periodic evaluation at the frequency specified for
* MaximumExecutionFrequency.
*
*
* -
*
* ConfigurationSnapshotDeliveryCompleted - Triggers a periodic evaluation when Config delivers
* a configuration snapshot.
*
*
*
*
* If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects,
* one for ConfigurationItemChangeNotification and one for
* OversizedConfigurationItemChangeNotification.
* @see MessageType
*/
public void setMessageType(MessageType messageType) {
withMessageType(messageType);
}
/**
*
* The type of notification that triggers Config to run an evaluation for a rule. You can specify the following
* notification types:
*
*
* -
*
* ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a configuration
* item as a result of a resource change.
*
*
* -
*
* OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an
* oversized configuration item. Config may generate this notification type when a resource changes and the
* notification exceeds the maximum size allowed by Amazon SNS.
*
*
* -
*
* ScheduledNotification - Triggers a periodic evaluation at the frequency specified for
* MaximumExecutionFrequency.
*
*
* -
*
* ConfigurationSnapshotDeliveryCompleted - Triggers a periodic evaluation when Config delivers a
* configuration snapshot.
*
*
*
*
* If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for
* ConfigurationItemChangeNotification and one for
* OversizedConfigurationItemChangeNotification.
*
*
* @param messageType
* The type of notification that triggers Config to run an evaluation for a rule. You can specify the
* following notification types:
*
* -
*
* ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a
* configuration item as a result of a resource change.
*
*
* -
*
* OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an
* oversized configuration item. Config may generate this notification type when a resource changes and the
* notification exceeds the maximum size allowed by Amazon SNS.
*
*
* -
*
* ScheduledNotification - Triggers a periodic evaluation at the frequency specified for
* MaximumExecutionFrequency.
*
*
* -
*
* ConfigurationSnapshotDeliveryCompleted - Triggers a periodic evaluation when Config delivers
* a configuration snapshot.
*
*
*
*
* If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects,
* one for ConfigurationItemChangeNotification and one for
* OversizedConfigurationItemChangeNotification.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MessageType
*/
public SourceDetail withMessageType(MessageType messageType) {
this.messageType = messageType.toString();
return this;
}
/**
*
* The frequency at which you want Config to run evaluations for a custom rule with a periodic trigger. If you
* specify a value for MaximumExecutionFrequency, then MessageType must use the
* ScheduledNotification value.
*
*
*
* By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid
* value for the MaximumExecutionFrequency parameter.
*
*
* Based on the valid value you choose, Config runs evaluations once for each valid value. For example, if you
* choose Three_Hours, Config runs evaluations once every three hours. In this case,
* Three_Hours is the frequency of this rule.
*
*
*
* @param maximumExecutionFrequency
* The frequency at which you want Config to run evaluations for a custom rule with a periodic trigger. If
* you specify a value for MaximumExecutionFrequency, then MessageType must use the
* ScheduledNotification value.
*
* By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a
* valid value for the MaximumExecutionFrequency parameter.
*
*
* Based on the valid value you choose, Config runs evaluations once for each valid value. For example, if
* you choose Three_Hours, Config runs evaluations once every three hours. In this case,
* Three_Hours is the frequency of this rule.
*
* @see MaximumExecutionFrequency
*/
public void setMaximumExecutionFrequency(String maximumExecutionFrequency) {
this.maximumExecutionFrequency = maximumExecutionFrequency;
}
/**
*
* The frequency at which you want Config to run evaluations for a custom rule with a periodic trigger. If you
* specify a value for MaximumExecutionFrequency, then MessageType must use the
* ScheduledNotification value.
*
*
*
* By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid
* value for the MaximumExecutionFrequency parameter.
*
*
* Based on the valid value you choose, Config runs evaluations once for each valid value. For example, if you
* choose Three_Hours, Config runs evaluations once every three hours. In this case,
* Three_Hours is the frequency of this rule.
*
*
*
* @return The frequency at which you want Config to run evaluations for a custom rule with a periodic trigger. If
* you specify a value for MaximumExecutionFrequency, then MessageType must use
* the ScheduledNotification value.
*
* By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify
* a valid value for the MaximumExecutionFrequency parameter.
*
*
* Based on the valid value you choose, Config runs evaluations once for each valid value. For example, if
* you choose Three_Hours, Config runs evaluations once every three hours. In this case,
* Three_Hours is the frequency of this rule.
*
* @see MaximumExecutionFrequency
*/
public String getMaximumExecutionFrequency() {
return this.maximumExecutionFrequency;
}
/**
*
* The frequency at which you want Config to run evaluations for a custom rule with a periodic trigger. If you
* specify a value for MaximumExecutionFrequency, then MessageType must use the
* ScheduledNotification value.
*
*
*
* By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid
* value for the MaximumExecutionFrequency parameter.
*
*
* Based on the valid value you choose, Config runs evaluations once for each valid value. For example, if you
* choose Three_Hours, Config runs evaluations once every three hours. In this case,
* Three_Hours is the frequency of this rule.
*
*
*
* @param maximumExecutionFrequency
* The frequency at which you want Config to run evaluations for a custom rule with a periodic trigger. If
* you specify a value for MaximumExecutionFrequency, then MessageType must use the
* ScheduledNotification value.
*
* By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a
* valid value for the MaximumExecutionFrequency parameter.
*
*
* Based on the valid value you choose, Config runs evaluations once for each valid value. For example, if
* you choose Three_Hours, Config runs evaluations once every three hours. In this case,
* Three_Hours is the frequency of this rule.
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see MaximumExecutionFrequency
*/
public SourceDetail withMaximumExecutionFrequency(String maximumExecutionFrequency) {
setMaximumExecutionFrequency(maximumExecutionFrequency);
return this;
}
/**
*
* The frequency at which you want Config to run evaluations for a custom rule with a periodic trigger. If you
* specify a value for MaximumExecutionFrequency, then MessageType must use the
* ScheduledNotification value.
*
*
*
* By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid
* value for the MaximumExecutionFrequency parameter.
*
*
* Based on the valid value you choose, Config runs evaluations once for each valid value. For example, if you
* choose Three_Hours, Config runs evaluations once every three hours. In this case,
* Three_Hours is the frequency of this rule.
*
*
*
* @param maximumExecutionFrequency
* The frequency at which you want Config to run evaluations for a custom rule with a periodic trigger. If
* you specify a value for MaximumExecutionFrequency, then MessageType must use the
* ScheduledNotification value.
*
* By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a
* valid value for the MaximumExecutionFrequency parameter.
*
*
* Based on the valid value you choose, Config runs evaluations once for each valid value. For example, if
* you choose Three_Hours, Config runs evaluations once every three hours. In this case,
* Three_Hours is the frequency of this rule.
*
* @see MaximumExecutionFrequency
*/
public void setMaximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency) {
withMaximumExecutionFrequency(maximumExecutionFrequency);
}
/**
*
* The frequency at which you want Config to run evaluations for a custom rule with a periodic trigger. If you
* specify a value for MaximumExecutionFrequency, then MessageType must use the
* ScheduledNotification value.
*
*
*
* By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid
* value for the MaximumExecutionFrequency parameter.
*
*
* Based on the valid value you choose, Config runs evaluations once for each valid value. For example, if you
* choose Three_Hours, Config runs evaluations once every three hours. In this case,
* Three_Hours is the frequency of this rule.
*
*
*
* @param maximumExecutionFrequency
* The frequency at which you want Config to run evaluations for a custom rule with a periodic trigger. If
* you specify a value for MaximumExecutionFrequency, then MessageType must use the
* ScheduledNotification value.
*
* By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a
* valid value for the MaximumExecutionFrequency parameter.
*
*
* Based on the valid value you choose, Config runs evaluations once for each valid value. For example, if
* you choose Three_Hours, Config runs evaluations once every three hours. In this case,
* Three_Hours is the frequency of this rule.
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see MaximumExecutionFrequency
*/
public SourceDetail withMaximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency) {
this.maximumExecutionFrequency = maximumExecutionFrequency.toString();
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 (getEventSource() != null)
sb.append("EventSource: ").append(getEventSource()).append(",");
if (getMessageType() != null)
sb.append("MessageType: ").append(getMessageType()).append(",");
if (getMaximumExecutionFrequency() != null)
sb.append("MaximumExecutionFrequency: ").append(getMaximumExecutionFrequency());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SourceDetail == false)
return false;
SourceDetail other = (SourceDetail) obj;
if (other.getEventSource() == null ^ this.getEventSource() == null)
return false;
if (other.getEventSource() != null && other.getEventSource().equals(this.getEventSource()) == false)
return false;
if (other.getMessageType() == null ^ this.getMessageType() == null)
return false;
if (other.getMessageType() != null && other.getMessageType().equals(this.getMessageType()) == false)
return false;
if (other.getMaximumExecutionFrequency() == null ^ this.getMaximumExecutionFrequency() == null)
return false;
if (other.getMaximumExecutionFrequency() != null && other.getMaximumExecutionFrequency().equals(this.getMaximumExecutionFrequency()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getEventSource() == null) ? 0 : getEventSource().hashCode());
hashCode = prime * hashCode + ((getMessageType() == null) ? 0 : getMessageType().hashCode());
hashCode = prime * hashCode + ((getMaximumExecutionFrequency() == null) ? 0 : getMaximumExecutionFrequency().hashCode());
return hashCode;
}
@Override
public SourceDetail clone() {
try {
return (SourceDetail) 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.config.model.transform.SourceDetailMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}