OrganizationManagedRuleMetadata (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class OrganizationManagedRuleMetadata
extends Object
implements Serializable, Cloneable, StructuredPojo
```
An object that specifies organization managed rule metadata such as resource type and ID of Amazon Web Services resource along with the rule identifier. 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

OrganizationManagedRuleMetadata()

Constructors
Constructor and Description
`OrganizationManagedRuleMetadata()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OrganizationManagedRuleMetadata`	`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`	`getMaximumExecutionFrequency()` The maximum frequency with which Config runs evaluations 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`	`getRuleIdentifier()` For organization config managed rules, a predefined identifier from a list.
`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`	`setMaximumExecutionFrequency(String maximumExecutionFrequency)` The maximum frequency with which Config runs evaluations 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`	`setRuleIdentifier(String ruleIdentifier)` For organization config managed rules, a predefined identifier from a list.
`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.
`OrganizationManagedRuleMetadata`	`withDescription(String description)` The description that you provide for your organization Config rule.
`OrganizationManagedRuleMetadata`	`withInputParameters(String inputParameters)` A string, in JSON format, that is passed to your organization Config rule Lambda function.
`OrganizationManagedRuleMetadata`	`withMaximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency)` The maximum frequency with which Config runs evaluations for a rule.
`OrganizationManagedRuleMetadata`	`withMaximumExecutionFrequency(String maximumExecutionFrequency)` The maximum frequency with which Config runs evaluations for a rule.
`OrganizationManagedRuleMetadata`	`withResourceIdScope(String resourceIdScope)` The ID of the Amazon Web Services resource that was evaluated.
`OrganizationManagedRuleMetadata`	`withResourceTypesScope(Collection<String> resourceTypesScope)` The type of the Amazon Web Services resource that was evaluated.
`OrganizationManagedRuleMetadata`	`withResourceTypesScope(String... resourceTypesScope)` The type of the Amazon Web Services resource that was evaluated.
`OrganizationManagedRuleMetadata`	`withRuleIdentifier(String ruleIdentifier)` For organization config managed rules, a predefined identifier from a list.
`OrganizationManagedRuleMetadata`	`withTagKeyScope(String tagKeyScope)` One part of a key-value pair that make up a tag.
`OrganizationManagedRuleMetadata`	`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
  - OrganizationManagedRuleMetadata
```
public OrganizationManagedRuleMetadata()
```
- 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 OrganizationManagedRuleMetadata 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.
  - setRuleIdentifier
```
public void setRuleIdentifier(String ruleIdentifier)
```
    For organization config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using Config managed rules.
    
    Parameters:
    
    ruleIdentifier - For organization config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using Config managed rules.
  - getRuleIdentifier
```
public String getRuleIdentifier()
```
    For organization config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using Config managed rules.
    
    Returns:
    
    For organization config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using Config managed rules.
  - withRuleIdentifier
```
public OrganizationManagedRuleMetadata withRuleIdentifier(String ruleIdentifier)
```
    For organization config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using Config managed rules.
    
    Parameters:
    
    ruleIdentifier - For organization config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using Config managed rules.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 OrganizationManagedRuleMetadata 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. This is for an Config managed rule that is triggered at a periodic frequency.
    
    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. This is for an Config managed rule that is triggered at a periodic frequency.
    
    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. This is for an Config managed rule that is triggered at a periodic frequency.
    
    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. This is for an Config managed rule that is triggered at a periodic frequency.
    
    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 OrganizationManagedRuleMetadata withMaximumExecutionFrequency(String maximumExecutionFrequency)
```
    The maximum frequency with which Config runs evaluations for a rule. This is for an Config managed rule that is triggered at a periodic frequency.
    
    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. This is for an Config managed rule that is triggered at a periodic frequency.
    
    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 OrganizationManagedRuleMetadata withMaximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency)
```
    The maximum frequency with which Config runs evaluations for a rule. This is for an Config managed rule that is triggered at a periodic frequency.
    
    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. This is for an Config managed rule that is triggered at a periodic frequency.
    
    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 OrganizationManagedRuleMetadata 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 OrganizationManagedRuleMetadata 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 OrganizationManagedRuleMetadata 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 OrganizationManagedRuleMetadata 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 OrganizationManagedRuleMetadata 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 OrganizationManagedRuleMetadata 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.604

Class OrganizationManagedRuleMetadata

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OrganizationManagedRuleMetadata

Method Detail

setDescription

getDescription

withDescription

setRuleIdentifier

getRuleIdentifier

withRuleIdentifier

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