com.amazonaws.services.config.model.ConfigSnapshotDeliveryProperties Maven / Gradle / Ivy
Show all versions of aws-java-sdk-config Show documentation
/*
* Copyright 2011-2016 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;
/**
*
* Provides options for how often AWS Config delivers configuration snapshots to
* the Amazon S3 bucket in your delivery channel.
*
*
*
* If you want to create a rule that triggers evaluations for your resources
* when AWS Config delivers the configuration snapshot, see the following:
*
*
*
* The frequency for a rule that triggers evaluations for your resources when
* AWS Config delivers the configuration snapshot is set by one of two values,
* depending on which is less frequent:
*
*
* -
*
* The value for the deliveryFrequency parameter within the
* delivery channel configuration, which sets how often AWS Config delivers
* configuration snapshots. This value also sets how often AWS Config invokes
* evaluations for Config rules.
*
*
* -
*
* The value for the MaximumExecutionFrequency parameter, which
* sets the maximum frequency with which AWS Config invokes evaluations for the
* rule. For more information, see ConfigRule.
*
*
*
*
* If the deliveryFrequency value is less frequent than the
* MaximumExecutionFrequency value for a rule, AWS Config invokes
* the rule only as often as the deliveryFrequency value.
*
*
* -
*
* For example, you want your rule to run evaluations when AWS Config delivers
* the configuration snapshot.
*
*
* -
*
* You specify the MaximumExecutionFrequency value for
* Six_Hours.
*
*
* -
*
* You then specify the delivery channel deliveryFrequency value
* for TwentyFour_Hours.
*
*
* -
*
* Because the value for deliveryFrequency is less frequent than
* MaximumExecutionFrequency, AWS Config invokes evaluations for
* the rule every 24 hours.
*
*
*
*
* You should set the MaximumExecutionFrequency value to be at
* least as frequent as the deliveryFrequency value. You can view
* the deliveryFrequency value by using the
* DescribeDeliveryChannnels action.
*
*
* To update the deliveryFrequency with which AWS Config delivers
* your configuration snapshots, use the PutDeliveryChannel action.
*
*/
public class ConfigSnapshotDeliveryProperties implements Serializable,
Cloneable {
/**
*
* The frequency with which AWS Config delivers configuration snapshots.
*
*/
private String deliveryFrequency;
/**
*
* The frequency with which AWS Config delivers configuration snapshots.
*
*
* @param deliveryFrequency
* The frequency with which AWS Config delivers configuration
* snapshots.
* @see MaximumExecutionFrequency
*/
public void setDeliveryFrequency(String deliveryFrequency) {
this.deliveryFrequency = deliveryFrequency;
}
/**
*
* The frequency with which AWS Config delivers configuration snapshots.
*
*
* @return The frequency with which AWS Config delivers configuration
* snapshots.
* @see MaximumExecutionFrequency
*/
public String getDeliveryFrequency() {
return this.deliveryFrequency;
}
/**
*
* The frequency with which AWS Config delivers configuration snapshots.
*
*
* @param deliveryFrequency
* The frequency with which AWS Config delivers configuration
* snapshots.
* @return Returns a reference to this object so that method calls can be
* chained together.
* @see MaximumExecutionFrequency
*/
public ConfigSnapshotDeliveryProperties withDeliveryFrequency(
String deliveryFrequency) {
setDeliveryFrequency(deliveryFrequency);
return this;
}
/**
*
* The frequency with which AWS Config delivers configuration snapshots.
*
*
* @param deliveryFrequency
* The frequency with which AWS Config delivers configuration
* snapshots.
* @see MaximumExecutionFrequency
*/
public void setDeliveryFrequency(MaximumExecutionFrequency deliveryFrequency) {
this.deliveryFrequency = deliveryFrequency.toString();
}
/**
*
* The frequency with which AWS Config delivers configuration snapshots.
*
*
* @param deliveryFrequency
* The frequency with which AWS Config delivers configuration
* snapshots.
* @return Returns a reference to this object so that method calls can be
* chained together.
* @see MaximumExecutionFrequency
*/
public ConfigSnapshotDeliveryProperties withDeliveryFrequency(
MaximumExecutionFrequency deliveryFrequency) {
setDeliveryFrequency(deliveryFrequency);
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getDeliveryFrequency() != null)
sb.append("DeliveryFrequency: " + getDeliveryFrequency());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ConfigSnapshotDeliveryProperties == false)
return false;
ConfigSnapshotDeliveryProperties other = (ConfigSnapshotDeliveryProperties) obj;
if (other.getDeliveryFrequency() == null
^ this.getDeliveryFrequency() == null)
return false;
if (other.getDeliveryFrequency() != null
&& other.getDeliveryFrequency().equals(
this.getDeliveryFrequency()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime
* hashCode
+ ((getDeliveryFrequency() == null) ? 0
: getDeliveryFrequency().hashCode());
return hashCode;
}
@Override
public ConfigSnapshotDeliveryProperties clone() {
try {
return (ConfigSnapshotDeliveryProperties) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException(
"Got a CloneNotSupportedException from Object.clone() "
+ "even though we're Cloneable!", e);
}
}
}