/* * Copyright 2018-2023 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; /** *
* organization custom rule metadata such as resource type, resource ID of Amazon Web Services resource, Lambda function * ARN, and organization trigger 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. *
* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class OrganizationCustomRuleMetadata implements Serializable, Cloneable, StructuredPojo { /** ** The description that you provide for your organization Config rule. *
*/ private String description; /** ** The lambda function ARN. *
*/ private String lambdaFunctionArn; /** ** 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
.
*
* A string, in JSON format, that is passed to your organization Config rule Lambda function. *
*/ private String inputParameters; /** ** The maximum frequency with which Config runs evaluations for a rule. Your custom rule is triggered when Config * delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties. *
*
* By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid
* value for the MaximumExecutionFrequency
parameter.
*
* The type of the Amazon Web Services resource that was evaluated. *
*/ private com.amazonaws.internal.SdkInternalList* The ID of the Amazon Web Services resource that was evaluated. *
*/ private String resourceIdScope; /** ** One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more * specific tag values. *
*/ private String tagKeyScope; /** ** The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category * (key). *
*/ private String tagValueScope; /** ** The description that you provide for your organization Config rule. *
* * @param description * The description that you provide for your organization Config rule. */ public void setDescription(String description) { this.description = description; } /** ** The description that you provide for your organization Config rule. *
* * @return The description that you provide for your organization Config rule. */ public String getDescription() { return this.description; } /** ** The description that you provide for your organization Config rule. *
* * @param description * The description that you provide for your organization Config rule. * @return Returns a reference to this object so that method calls can be chained together. */ public OrganizationCustomRuleMetadata withDescription(String description) { setDescription(description); return this; } /** ** The lambda function ARN. *
* * @param lambdaFunctionArn * The lambda function ARN. */ public void setLambdaFunctionArn(String lambdaFunctionArn) { this.lambdaFunctionArn = lambdaFunctionArn; } /** ** The lambda function ARN. *
* * @return The lambda function ARN. */ public String getLambdaFunctionArn() { return this.lambdaFunctionArn; } /** ** The lambda function ARN. *
* * @param lambdaFunctionArn * The lambda function ARN. * @return Returns a reference to this object so that method calls can be chained together. */ public OrganizationCustomRuleMetadata withLambdaFunctionArn(String lambdaFunctionArn) { setLambdaFunctionArn(lambdaFunctionArn); 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
.
*
* 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
.
*
* 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
.
*
* 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
.
*
* 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
.
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setOrganizationConfigRuleTriggerTypes(java.util.Collection)} or * {@link #withOrganizationConfigRuleTriggerTypes(java.util.Collection)} if you want to override the existing * values. *
* * @param organizationConfigRuleTriggerTypes * 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
.
*
* 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
.
*
* 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
.
*
* 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
.
*
* 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
.
*
* A string, in JSON format, that is passed to your organization Config rule Lambda function. *
* * @param inputParameters * A string, in JSON format, that is passed to your organization Config rule Lambda function. */ public void setInputParameters(String inputParameters) { this.inputParameters = inputParameters; } /** ** A string, in JSON format, that is passed to your organization Config rule Lambda function. *
* * @return A string, in JSON format, that is passed to your organization Config rule Lambda function. */ public String getInputParameters() { return this.inputParameters; } /** ** A string, in JSON format, that is passed to your organization Config rule Lambda function. *
* * @param inputParameters * A string, in JSON format, that is passed to your organization Config rule Lambda function. * @return Returns a reference to this object so that method calls can be chained together. */ public OrganizationCustomRuleMetadata withInputParameters(String inputParameters) { setInputParameters(inputParameters); return this; } /** ** The maximum frequency with which Config runs evaluations for a rule. Your custom rule is triggered when Config * delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties. *
*
* By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid
* value for the MaximumExecutionFrequency
parameter.
*
* By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a
* valid value for the MaximumExecutionFrequency
parameter.
*
* The maximum frequency with which Config runs evaluations for a rule. Your custom rule is triggered when Config * delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties. *
*
* By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid
* value for the MaximumExecutionFrequency
parameter.
*
* By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify
* a valid value for the MaximumExecutionFrequency
parameter.
*
* The maximum frequency with which Config runs evaluations for a rule. Your custom rule is triggered when Config * delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties. *
*
* By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid
* value for the MaximumExecutionFrequency
parameter.
*
* By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a
* valid value for the MaximumExecutionFrequency
parameter.
*
* The maximum frequency with which Config runs evaluations for a rule. Your custom rule is triggered when Config * delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties. *
*
* By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid
* value for the MaximumExecutionFrequency
parameter.
*
* By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a
* valid value for the MaximumExecutionFrequency
parameter.
*
* The type of the Amazon Web Services resource that was evaluated. *
* * @return The type of the Amazon Web Services resource that was evaluated. */ public java.util.List* The type of the Amazon Web Services resource that was evaluated. *
* * @param resourceTypesScope * The type of the Amazon Web Services resource that was evaluated. */ public void setResourceTypesScope(java.util.Collection* The type of the Amazon Web Services resource that was evaluated. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setResourceTypesScope(java.util.Collection)} or {@link #withResourceTypesScope(java.util.Collection)} if * you want to override the existing values. *
* * @param resourceTypesScope * The type of the Amazon Web Services resource that was evaluated. * @return Returns a reference to this object so that method calls can be chained together. */ public OrganizationCustomRuleMetadata withResourceTypesScope(String... resourceTypesScope) { if (this.resourceTypesScope == null) { setResourceTypesScope(new com.amazonaws.internal.SdkInternalList* The type of the Amazon Web Services resource that was evaluated. *
* * @param resourceTypesScope * The type of the Amazon Web Services resource that was evaluated. * @return Returns a reference to this object so that method calls can be chained together. */ public OrganizationCustomRuleMetadata withResourceTypesScope(java.util.Collection* The ID of the Amazon Web Services resource that was evaluated. *
* * @param resourceIdScope * The ID of the Amazon Web Services resource that was evaluated. */ public void setResourceIdScope(String resourceIdScope) { this.resourceIdScope = resourceIdScope; } /** ** The ID of the Amazon Web Services resource that was evaluated. *
* * @return The ID of the Amazon Web Services resource that was evaluated. */ public String getResourceIdScope() { return this.resourceIdScope; } /** ** The ID of the Amazon Web Services resource that was evaluated. *
* * @param resourceIdScope * The ID of the Amazon Web Services resource that was evaluated. * @return Returns a reference to this object so that method calls can be chained together. */ public OrganizationCustomRuleMetadata withResourceIdScope(String resourceIdScope) { setResourceIdScope(resourceIdScope); return this; } /** ** One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more * specific tag values. *
* * @param tagKeyScope * One part of a key-value pair that make up a tag. A key is a general label that acts like a category for * more specific tag values. */ public void setTagKeyScope(String tagKeyScope) { this.tagKeyScope = tagKeyScope; } /** ** One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more * specific tag values. *
* * @return One part of a key-value pair that make up a tag. A key is a general label that acts like a category for * more specific tag values. */ public String getTagKeyScope() { return this.tagKeyScope; } /** ** One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more * specific tag values. *
* * @param tagKeyScope * One part of a key-value pair that make up a tag. A key is a general label that acts like a category for * more specific tag values. * @return Returns a reference to this object so that method calls can be chained together. */ public OrganizationCustomRuleMetadata withTagKeyScope(String tagKeyScope) { setTagKeyScope(tagKeyScope); return this; } /** ** The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category * (key). *
* * @param tagValueScope * The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag * category (key). */ public void setTagValueScope(String tagValueScope) { this.tagValueScope = tagValueScope; } /** ** The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category * (key). *
* * @return The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag * category (key). */ public String getTagValueScope() { return this.tagValueScope; } /** ** The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category * (key). *
* * @param tagValueScope * The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag * category (key). * @return Returns a reference to this object so that method calls can be chained together. */ public OrganizationCustomRuleMetadata withTagValueScope(String tagValueScope) { setTagValueScope(tagValueScope); 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 (getDescription() != null) sb.append("Description: ").append(getDescription()).append(","); if (getLambdaFunctionArn() != null) sb.append("LambdaFunctionArn: ").append(getLambdaFunctionArn()).append(","); if (getOrganizationConfigRuleTriggerTypes() != null) sb.append("OrganizationConfigRuleTriggerTypes: ").append(getOrganizationConfigRuleTriggerTypes()).append(","); if (getInputParameters() != null) sb.append("InputParameters: ").append(getInputParameters()).append(","); if (getMaximumExecutionFrequency() != null) sb.append("MaximumExecutionFrequency: ").append(getMaximumExecutionFrequency()).append(","); if (getResourceTypesScope() != null) sb.append("ResourceTypesScope: ").append(getResourceTypesScope()).append(","); if (getResourceIdScope() != null) sb.append("ResourceIdScope: ").append(getResourceIdScope()).append(","); if (getTagKeyScope() != null) sb.append("TagKeyScope: ").append(getTagKeyScope()).append(","); if (getTagValueScope() != null) sb.append("TagValueScope: ").append(getTagValueScope()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof OrganizationCustomRuleMetadata == false) return false; OrganizationCustomRuleMetadata other = (OrganizationCustomRuleMetadata) obj; if (other.getDescription() == null ^ this.getDescription() == null) return false; if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false) return false; if (other.getLambdaFunctionArn() == null ^ this.getLambdaFunctionArn() == null) return false; if (other.getLambdaFunctionArn() != null && other.getLambdaFunctionArn().equals(this.getLambdaFunctionArn()) == false) return false; if (other.getOrganizationConfigRuleTriggerTypes() == null ^ this.getOrganizationConfigRuleTriggerTypes() == null) return false; if (other.getOrganizationConfigRuleTriggerTypes() != null && other.getOrganizationConfigRuleTriggerTypes().equals(this.getOrganizationConfigRuleTriggerTypes()) == false) return false; if (other.getInputParameters() == null ^ this.getInputParameters() == null) return false; if (other.getInputParameters() != null && other.getInputParameters().equals(this.getInputParameters()) == false) return false; if (other.getMaximumExecutionFrequency() == null ^ this.getMaximumExecutionFrequency() == null) return false; if (other.getMaximumExecutionFrequency() != null && other.getMaximumExecutionFrequency().equals(this.getMaximumExecutionFrequency()) == false) return false; if (other.getResourceTypesScope() == null ^ this.getResourceTypesScope() == null) return false; if (other.getResourceTypesScope() != null && other.getResourceTypesScope().equals(this.getResourceTypesScope()) == false) return false; if (other.getResourceIdScope() == null ^ this.getResourceIdScope() == null) return false; if (other.getResourceIdScope() != null && other.getResourceIdScope().equals(this.getResourceIdScope()) == false) return false; if (other.getTagKeyScope() == null ^ this.getTagKeyScope() == null) return false; if (other.getTagKeyScope() != null && other.getTagKeyScope().equals(this.getTagKeyScope()) == false) return false; if (other.getTagValueScope() == null ^ this.getTagValueScope() == null) return false; if (other.getTagValueScope() != null && other.getTagValueScope().equals(this.getTagValueScope()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode()); hashCode = prime * hashCode + ((getLambdaFunctionArn() == null) ? 0 : getLambdaFunctionArn().hashCode()); hashCode = prime * hashCode + ((getOrganizationConfigRuleTriggerTypes() == null) ? 0 : getOrganizationConfigRuleTriggerTypes().hashCode()); hashCode = prime * hashCode + ((getInputParameters() == null) ? 0 : getInputParameters().hashCode()); hashCode = prime * hashCode + ((getMaximumExecutionFrequency() == null) ? 0 : getMaximumExecutionFrequency().hashCode()); hashCode = prime * hashCode + ((getResourceTypesScope() == null) ? 0 : getResourceTypesScope().hashCode()); hashCode = prime * hashCode + ((getResourceIdScope() == null) ? 0 : getResourceIdScope().hashCode()); hashCode = prime * hashCode + ((getTagKeyScope() == null) ? 0 : getTagKeyScope().hashCode()); hashCode = prime * hashCode + ((getTagValueScope() == null) ? 0 : getTagValueScope().hashCode()); return hashCode; } @Override public OrganizationCustomRuleMetadata clone() { try { return (OrganizationCustomRuleMetadata) 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.OrganizationCustomRuleMetadataMarshaller.getInstance().marshall(this, protocolMarshaller); } }