OrganizationCustomRuleMetadata (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.config.model.OrganizationCustomRuleMetadata

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class OrganizationCustomRuleMetadata
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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 Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

OrganizationCustomRuleMetadata()

Constructors
Constructor and Description
`OrganizationCustomRuleMetadata()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OrganizationCustomRuleMetadata`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDescription()` The description that you provide for your organization Config rule.
`String`	`getInputParameters()` A string, in JSON format, that is passed to your organization Config rule Lambda function.
`String`	`getLambdaFunctionArn()` The lambda function ARN.
`String`	`getMaximumExecutionFrequency()` The maximum frequency with which Config runs evaluations for a rule.
`List<String>`	`getOrganizationConfigRuleTriggerTypes()` The type of notification that triggers Config to run an evaluation for a rule.
`String`	`getResourceIdScope()` The ID of the Amazon Web Services resource that was evaluated.
`List<String>`	`getResourceTypesScope()` The type of the Amazon Web Services resource that was evaluated.
`String`	`getTagKeyScope()` One part of a key-value pair that make up a tag.
`String`	`getTagValueScope()` The optional part of a key-value pair that make up a tag.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDescription(String description)` The description that you provide for your organization Config rule.
`void`	`setInputParameters(String inputParameters)` A string, in JSON format, that is passed to your organization Config rule Lambda function.
`void`	`setLambdaFunctionArn(String lambdaFunctionArn)` The lambda function ARN.
`void`	`setMaximumExecutionFrequency(String maximumExecutionFrequency)` The maximum frequency with which Config runs evaluations for a rule.
`void`	`setOrganizationConfigRuleTriggerTypes(Collection<String> organizationConfigRuleTriggerTypes)` The type of notification that triggers Config to run an evaluation for a rule.
`void`	`setResourceIdScope(String resourceIdScope)` The ID of the Amazon Web Services resource that was evaluated.
`void`	`setResourceTypesScope(Collection<String> resourceTypesScope)` The type of the Amazon Web Services resource that was evaluated.
`void`	`setTagKeyScope(String tagKeyScope)` One part of a key-value pair that make up a tag.
`void`	`setTagValueScope(String tagValueScope)` The optional part of a key-value pair that make up a tag.
`String`	`toString()` Returns a string representation of this object.
`OrganizationCustomRuleMetadata`	`withDescription(String description)` The description that you provide for your organization Config rule.
`OrganizationCustomRuleMetadata`	`withInputParameters(String inputParameters)` A string, in JSON format, that is passed to your organization Config rule Lambda function.
`OrganizationCustomRuleMetadata`	`withLambdaFunctionArn(String lambdaFunctionArn)` The lambda function ARN.
`OrganizationCustomRuleMetadata`	`withMaximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency)` The maximum frequency with which Config runs evaluations for a rule.
`OrganizationCustomRuleMetadata`	`withMaximumExecutionFrequency(String maximumExecutionFrequency)` The maximum frequency with which Config runs evaluations for a rule.
`OrganizationCustomRuleMetadata`	`withOrganizationConfigRuleTriggerTypes(Collection<String> organizationConfigRuleTriggerTypes)` The type of notification that triggers Config to run an evaluation for a rule.
`OrganizationCustomRuleMetadata`	`withOrganizationConfigRuleTriggerTypes(OrganizationConfigRuleTriggerType... organizationConfigRuleTriggerTypes)` The type of notification that triggers Config to run an evaluation for a rule.
`OrganizationCustomRuleMetadata`	`withOrganizationConfigRuleTriggerTypes(String... organizationConfigRuleTriggerTypes)` The type of notification that triggers Config to run an evaluation for a rule.
`OrganizationCustomRuleMetadata`	`withResourceIdScope(String resourceIdScope)` The ID of the Amazon Web Services resource that was evaluated.
`OrganizationCustomRuleMetadata`	`withResourceTypesScope(Collection<String> resourceTypesScope)` The type of the Amazon Web Services resource that was evaluated.
`OrganizationCustomRuleMetadata`	`withResourceTypesScope(String... resourceTypesScope)` The type of the Amazon Web Services resource that was evaluated.
`OrganizationCustomRuleMetadata`	`withTagKeyScope(String tagKeyScope)` One part of a key-value pair that make up a tag.
`OrganizationCustomRuleMetadata`	`withTagValueScope(String tagValueScope)` The optional part of a key-value pair that make up a tag.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - OrganizationCustomRuleMetadata
```
public OrganizationCustomRuleMetadata()
```
- Method Detail
  - setDescription
```
public void setDescription(String description)
```
    The description that you provide for your organization Config rule.
    
    Parameters:
    
    description - The description that you provide for your organization Config rule.
  - getDescription
```
public String getDescription()
```
    The description that you provide for your organization Config rule.
    
    Returns:
    
    The description that you provide for your organization Config rule.
  - withDescription
```
public OrganizationCustomRuleMetadata withDescription(String description)
```
    The description that you provide for your organization Config rule.
    
    Parameters:
    
    description - The description that you provide for your organization Config rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLambdaFunctionArn
```
public void setLambdaFunctionArn(String lambdaFunctionArn)
```
    The lambda function ARN.
    
    Parameters:
    
    lambdaFunctionArn - The lambda function ARN.
  - getLambdaFunctionArn
```
public String getLambdaFunctionArn()
```
    The lambda function ARN.
    
    Returns:
    
    The lambda function ARN.
  - withLambdaFunctionArn
```
public OrganizationCustomRuleMetadata withLambdaFunctionArn(String lambdaFunctionArn)
```
    The lambda function ARN.
    
    Parameters:
    
    lambdaFunctionArn - The lambda function ARN.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getOrganizationConfigRuleTriggerTypes
```
public List<String> getOrganizationConfigRuleTriggerTypes()
```
    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.
    Returns:
    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.
    See Also:
    
    OrganizationConfigRuleTriggerType
  - setOrganizationConfigRuleTriggerTypes
```
public void setOrganizationConfigRuleTriggerTypes(Collection<String> 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.
    Parameters:
    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.
    See Also:
    
    OrganizationConfigRuleTriggerType
  - withOrganizationConfigRuleTriggerTypes
```
public OrganizationCustomRuleMetadata withOrganizationConfigRuleTriggerTypes(String... 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.
    NOTE: This method appends the values to the existing list (if any). Use setOrganizationConfigRuleTriggerTypes(java.util.Collection) or withOrganizationConfigRuleTriggerTypes(java.util.Collection) if you want to override the existing values.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OrganizationConfigRuleTriggerType
  - withOrganizationConfigRuleTriggerTypes
```
public OrganizationCustomRuleMetadata withOrganizationConfigRuleTriggerTypes(Collection<String> 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OrganizationConfigRuleTriggerType
  - withOrganizationConfigRuleTriggerTypes
```
public OrganizationCustomRuleMetadata withOrganizationConfigRuleTriggerTypes(OrganizationConfigRuleTriggerType... 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OrganizationConfigRuleTriggerType
  - setInputParameters
```
public void setInputParameters(String inputParameters)
```
    A string, in JSON format, that is passed to your organization Config rule Lambda function.
    
    Parameters:
    
    inputParameters - A string, in JSON format, that is passed to your organization Config rule Lambda function.
  - getInputParameters
```
public String getInputParameters()
```
    A string, in JSON format, that is passed to your organization Config rule Lambda function.
    
    Returns:
    
    A string, in JSON format, that is passed to your organization Config rule Lambda function.
  - withInputParameters
```
public OrganizationCustomRuleMetadata withInputParameters(String inputParameters)
```
    A string, in JSON format, that is passed to your organization Config rule Lambda function.
    
    Parameters:
    
    inputParameters - A string, in JSON format, that is passed to your organization Config rule Lambda function.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaximumExecutionFrequency
```
public void setMaximumExecutionFrequency(String maximumExecutionFrequency)
```
    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.
    
    Parameters:
    
    maximumExecutionFrequency - 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.
    
    See Also:
    
    MaximumExecutionFrequency
  - getMaximumExecutionFrequency
```
public String getMaximumExecutionFrequency()
```
    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.
    
    Returns:
    
    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.
    
    See Also:
    
    MaximumExecutionFrequency
  - withMaximumExecutionFrequency
```
public OrganizationCustomRuleMetadata withMaximumExecutionFrequency(String maximumExecutionFrequency)
```
    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.
    
    Parameters:
    
    maximumExecutionFrequency - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MaximumExecutionFrequency
  - withMaximumExecutionFrequency
```
public OrganizationCustomRuleMetadata withMaximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency)
```
    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.
    
    Parameters:
    
    maximumExecutionFrequency - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MaximumExecutionFrequency
  - getResourceTypesScope
```
public List<String> getResourceTypesScope()
```
    The type of the Amazon Web Services resource that was evaluated.
    
    Returns:
    
    The type of the Amazon Web Services resource that was evaluated.
  - setResourceTypesScope
```
public void setResourceTypesScope(Collection<String> resourceTypesScope)
```
    The type of the Amazon Web Services resource that was evaluated.
    
    Parameters:
    
    resourceTypesScope - The type of the Amazon Web Services resource that was evaluated.
  - withResourceTypesScope
```
public OrganizationCustomRuleMetadata withResourceTypesScope(String... resourceTypesScope)
```
    The type of the Amazon Web Services resource that was evaluated.
    
    NOTE: This method appends the values to the existing list (if any). Use setResourceTypesScope(java.util.Collection) or withResourceTypesScope(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    resourceTypesScope - The type of the Amazon Web Services resource that was evaluated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withResourceTypesScope
```
public OrganizationCustomRuleMetadata withResourceTypesScope(Collection<String> resourceTypesScope)
```
    The type of the Amazon Web Services resource that was evaluated.
    
    Parameters:
    
    resourceTypesScope - The type of the Amazon Web Services resource that was evaluated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceIdScope
```
public void setResourceIdScope(String resourceIdScope)
```
    The ID of the Amazon Web Services resource that was evaluated.
    
    Parameters:
    
    resourceIdScope - The ID of the Amazon Web Services resource that was evaluated.
  - getResourceIdScope
```
public String getResourceIdScope()
```
    The ID of the Amazon Web Services resource that was evaluated.
    
    Returns:
    
    The ID of the Amazon Web Services resource that was evaluated.
  - withResourceIdScope
```
public OrganizationCustomRuleMetadata withResourceIdScope(String resourceIdScope)
```
    The ID of the Amazon Web Services resource that was evaluated.
    
    Parameters:
    
    resourceIdScope - The ID of the Amazon Web Services resource that was evaluated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTagKeyScope
```
public void setTagKeyScope(String 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.
    
    Parameters:
    
    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.
  - getTagKeyScope
```
public String getTagKeyScope()
```
    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.
    
    Returns:
    
    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.
  - withTagKeyScope
```
public OrganizationCustomRuleMetadata withTagKeyScope(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTagValueScope
```
public void setTagValueScope(String 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).
    
    Parameters:
    
    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).
  - getTagValueScope
```
public String getTagValueScope()
```
    The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
    
    Returns:
    
    The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
  - withTagValueScope
```
public OrganizationCustomRuleMetadata withTagValueScope(String 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).
    
    Parameters:
    
    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).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String 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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public OrganizationCustomRuleMetadata clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.556

Class OrganizationCustomRuleMetadata

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OrganizationCustomRuleMetadata

Method Detail

setDescription

getDescription

withDescription

setLambdaFunctionArn

getLambdaFunctionArn

withLambdaFunctionArn

getOrganizationConfigRuleTriggerTypes

setOrganizationConfigRuleTriggerTypes

withOrganizationConfigRuleTriggerTypes

withOrganizationConfigRuleTriggerTypes

withOrganizationConfigRuleTriggerTypes

setInputParameters

getInputParameters

withInputParameters

setMaximumExecutionFrequency

getMaximumExecutionFrequency

withMaximumExecutionFrequency

withMaximumExecutionFrequency

getResourceTypesScope

setResourceTypesScope

withResourceTypesScope

withResourceTypesScope

setResourceIdScope

getResourceIdScope

withResourceIdScope

setTagKeyScope

getTagKeyScope

withTagKeyScope

setTagValueScope

getTagValueScope

withTagValueScope

toString

equals

hashCode

clone

marshall