@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class OrganizationCustomPolicyRuleMetadata extends Object implements Serializable, Cloneable, StructuredPojo
An object that specifies metadata for your organization's Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that initiate Config to evaluate Amazon Web Services resources against a rule.
Constructor and Description |
---|
OrganizationCustomPolicyRuleMetadata() |
Modifier and Type | Method and Description |
---|---|
OrganizationCustomPolicyRuleMetadata |
clone() |
boolean |
equals(Object obj) |
List<String> |
getDebugLogDeliveryAccounts()
A list of accounts that you can enable debug logging for your organization Config Custom Policy rule.
|
String |
getDescription()
The description that you provide for your organization Config Custom Policy rule.
|
String |
getInputParameters()
A string, in JSON format, that is passed to your organization Config Custom Policy rule.
|
String |
getMaximumExecutionFrequency()
The maximum frequency with which Config runs evaluations for a rule.
|
List<String> |
getOrganizationConfigRuleTriggerTypes()
The type of notification that initiates Config to run an evaluation for a rule.
|
String |
getPolicyRuntime()
The runtime system for your organization Config Custom Policy rules.
|
String |
getPolicyText()
The policy definition containing the logic for your organization Config Custom Policy 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 |
setDebugLogDeliveryAccounts(Collection<String> debugLogDeliveryAccounts)
A list of accounts that you can enable debug logging for your organization Config Custom Policy rule.
|
void |
setDescription(String description)
The description that you provide for your organization Config Custom Policy rule.
|
void |
setInputParameters(String inputParameters)
A string, in JSON format, that is passed to your organization Config Custom Policy rule.
|
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 initiates Config to run an evaluation for a rule.
|
void |
setPolicyRuntime(String policyRuntime)
The runtime system for your organization Config Custom Policy rules.
|
void |
setPolicyText(String policyText)
The policy definition containing the logic for your organization Config Custom Policy 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.
|
OrganizationCustomPolicyRuleMetadata |
withDebugLogDeliveryAccounts(Collection<String> debugLogDeliveryAccounts)
A list of accounts that you can enable debug logging for your organization Config Custom Policy rule.
|
OrganizationCustomPolicyRuleMetadata |
withDebugLogDeliveryAccounts(String... debugLogDeliveryAccounts)
A list of accounts that you can enable debug logging for your organization Config Custom Policy rule.
|
OrganizationCustomPolicyRuleMetadata |
withDescription(String description)
The description that you provide for your organization Config Custom Policy rule.
|
OrganizationCustomPolicyRuleMetadata |
withInputParameters(String inputParameters)
A string, in JSON format, that is passed to your organization Config Custom Policy rule.
|
OrganizationCustomPolicyRuleMetadata |
withMaximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency)
The maximum frequency with which Config runs evaluations for a rule.
|
OrganizationCustomPolicyRuleMetadata |
withMaximumExecutionFrequency(String maximumExecutionFrequency)
The maximum frequency with which Config runs evaluations for a rule.
|
OrganizationCustomPolicyRuleMetadata |
withOrganizationConfigRuleTriggerTypes(Collection<String> organizationConfigRuleTriggerTypes)
The type of notification that initiates Config to run an evaluation for a rule.
|
OrganizationCustomPolicyRuleMetadata |
withOrganizationConfigRuleTriggerTypes(OrganizationConfigRuleTriggerTypeNoSN... organizationConfigRuleTriggerTypes)
The type of notification that initiates Config to run an evaluation for a rule.
|
OrganizationCustomPolicyRuleMetadata |
withOrganizationConfigRuleTriggerTypes(String... organizationConfigRuleTriggerTypes)
The type of notification that initiates Config to run an evaluation for a rule.
|
OrganizationCustomPolicyRuleMetadata |
withPolicyRuntime(String policyRuntime)
The runtime system for your organization Config Custom Policy rules.
|
OrganizationCustomPolicyRuleMetadata |
withPolicyText(String policyText)
The policy definition containing the logic for your organization Config Custom Policy rule.
|
OrganizationCustomPolicyRuleMetadata |
withResourceIdScope(String resourceIdScope)
The ID of the Amazon Web Services resource that was evaluated.
|
OrganizationCustomPolicyRuleMetadata |
withResourceTypesScope(Collection<String> resourceTypesScope)
The type of the Amazon Web Services resource that was evaluated.
|
OrganizationCustomPolicyRuleMetadata |
withResourceTypesScope(String... resourceTypesScope)
The type of the Amazon Web Services resource that was evaluated.
|
OrganizationCustomPolicyRuleMetadata |
withTagKeyScope(String tagKeyScope)
One part of a key-value pair that make up a tag.
|
OrganizationCustomPolicyRuleMetadata |
withTagValueScope(String tagValueScope)
The optional part of a key-value pair that make up a tag.
|
public OrganizationCustomPolicyRuleMetadata()
public void setDescription(String description)
The description that you provide for your organization Config Custom Policy rule.
description
- The description that you provide for your organization Config Custom Policy rule.public String getDescription()
The description that you provide for your organization Config Custom Policy rule.
public OrganizationCustomPolicyRuleMetadata withDescription(String description)
The description that you provide for your organization Config Custom Policy rule.
description
- The description that you provide for your organization Config Custom Policy rule.public List<String> getOrganizationConfigRuleTriggerTypes()
The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change-initiated notification types:
ConfigurationItemChangeNotification
- Initiates an evaluation when Config delivers a configuration
item as a result of a resource change.
OversizedConfigurationItemChangeNotification
- Initiates 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.
ConfigurationItemChangeNotification
- Initiates an evaluation when Config delivers a
configuration item as a result of a resource change.
OversizedConfigurationItemChangeNotification
- Initiates 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.
OrganizationConfigRuleTriggerTypeNoSN
public void setOrganizationConfigRuleTriggerTypes(Collection<String> organizationConfigRuleTriggerTypes)
The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change-initiated notification types:
ConfigurationItemChangeNotification
- Initiates an evaluation when Config delivers a configuration
item as a result of a resource change.
OversizedConfigurationItemChangeNotification
- Initiates 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.
organizationConfigRuleTriggerTypes
- The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy
rules, Config supports change-initiated notification types:
ConfigurationItemChangeNotification
- Initiates an evaluation when Config delivers a
configuration item as a result of a resource change.
OversizedConfigurationItemChangeNotification
- Initiates 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.
OrganizationConfigRuleTriggerTypeNoSN
public OrganizationCustomPolicyRuleMetadata withOrganizationConfigRuleTriggerTypes(String... organizationConfigRuleTriggerTypes)
The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change-initiated notification types:
ConfigurationItemChangeNotification
- Initiates an evaluation when Config delivers a configuration
item as a result of a resource change.
OversizedConfigurationItemChangeNotification
- Initiates 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.
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.
organizationConfigRuleTriggerTypes
- The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy
rules, Config supports change-initiated notification types:
ConfigurationItemChangeNotification
- Initiates an evaluation when Config delivers a
configuration item as a result of a resource change.
OversizedConfigurationItemChangeNotification
- Initiates 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.
OrganizationConfigRuleTriggerTypeNoSN
public OrganizationCustomPolicyRuleMetadata withOrganizationConfigRuleTriggerTypes(Collection<String> organizationConfigRuleTriggerTypes)
The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change-initiated notification types:
ConfigurationItemChangeNotification
- Initiates an evaluation when Config delivers a configuration
item as a result of a resource change.
OversizedConfigurationItemChangeNotification
- Initiates 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.
organizationConfigRuleTriggerTypes
- The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy
rules, Config supports change-initiated notification types:
ConfigurationItemChangeNotification
- Initiates an evaluation when Config delivers a
configuration item as a result of a resource change.
OversizedConfigurationItemChangeNotification
- Initiates 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.
OrganizationConfigRuleTriggerTypeNoSN
public OrganizationCustomPolicyRuleMetadata withOrganizationConfigRuleTriggerTypes(OrganizationConfigRuleTriggerTypeNoSN... organizationConfigRuleTriggerTypes)
The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change-initiated notification types:
ConfigurationItemChangeNotification
- Initiates an evaluation when Config delivers a configuration
item as a result of a resource change.
OversizedConfigurationItemChangeNotification
- Initiates 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.
organizationConfigRuleTriggerTypes
- The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy
rules, Config supports change-initiated notification types:
ConfigurationItemChangeNotification
- Initiates an evaluation when Config delivers a
configuration item as a result of a resource change.
OversizedConfigurationItemChangeNotification
- Initiates 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.
OrganizationConfigRuleTriggerTypeNoSN
public void setInputParameters(String inputParameters)
A string, in JSON format, that is passed to your organization Config Custom Policy rule.
inputParameters
- A string, in JSON format, that is passed to your organization Config Custom Policy rule.public String getInputParameters()
A string, in JSON format, that is passed to your organization Config Custom Policy rule.
public OrganizationCustomPolicyRuleMetadata withInputParameters(String inputParameters)
A string, in JSON format, that is passed to your organization Config Custom Policy rule.
inputParameters
- A string, in JSON format, that is passed to your organization Config Custom Policy rule.public void setMaximumExecutionFrequency(String maximumExecutionFrequency)
The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
maximumExecutionFrequency
- The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is
triggered when Config delivers the configuration snapshot. For more information, see
ConfigSnapshotDeliveryProperties.MaximumExecutionFrequency
public String getMaximumExecutionFrequency()
The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
MaximumExecutionFrequency
public OrganizationCustomPolicyRuleMetadata withMaximumExecutionFrequency(String maximumExecutionFrequency)
The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
maximumExecutionFrequency
- The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is
triggered when Config delivers the configuration snapshot. For more information, see
ConfigSnapshotDeliveryProperties.MaximumExecutionFrequency
public OrganizationCustomPolicyRuleMetadata withMaximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency)
The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
maximumExecutionFrequency
- The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is
triggered when Config delivers the configuration snapshot. For more information, see
ConfigSnapshotDeliveryProperties.MaximumExecutionFrequency
public List<String> getResourceTypesScope()
The type of the Amazon Web Services resource that was evaluated.
public void setResourceTypesScope(Collection<String> resourceTypesScope)
The type of the Amazon Web Services resource that was evaluated.
resourceTypesScope
- The type of the Amazon Web Services resource that was evaluated.public OrganizationCustomPolicyRuleMetadata 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.
resourceTypesScope
- The type of the Amazon Web Services resource that was evaluated.public OrganizationCustomPolicyRuleMetadata withResourceTypesScope(Collection<String> resourceTypesScope)
The type of the Amazon Web Services resource that was evaluated.
resourceTypesScope
- The type of the Amazon Web Services resource that was evaluated.public void setResourceIdScope(String resourceIdScope)
The ID of the Amazon Web Services resource that was evaluated.
resourceIdScope
- The ID of the Amazon Web Services resource that was evaluated.public String getResourceIdScope()
The ID of the Amazon Web Services resource that was evaluated.
public OrganizationCustomPolicyRuleMetadata withResourceIdScope(String resourceIdScope)
The ID of the Amazon Web Services resource that was evaluated.
resourceIdScope
- The ID of the Amazon Web Services resource that was evaluated.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.
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 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.
public OrganizationCustomPolicyRuleMetadata 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.
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 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).
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 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).
public OrganizationCustomPolicyRuleMetadata 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).
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 setPolicyRuntime(String policyRuntime)
The runtime system for your organization Config Custom Policy rules. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository.
policyRuntime
- The runtime system for your organization Config Custom Policy rules. Guard is a policy-as-code language
that allows you to write policies that are enforced by Config Custom Policy rules. For more information
about Guard, see the Guard GitHub
Repository.public String getPolicyRuntime()
The runtime system for your organization Config Custom Policy rules. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository.
public OrganizationCustomPolicyRuleMetadata withPolicyRuntime(String policyRuntime)
The runtime system for your organization Config Custom Policy rules. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository.
policyRuntime
- The runtime system for your organization Config Custom Policy rules. Guard is a policy-as-code language
that allows you to write policies that are enforced by Config Custom Policy rules. For more information
about Guard, see the Guard GitHub
Repository.public void setPolicyText(String policyText)
The policy definition containing the logic for your organization Config Custom Policy rule.
policyText
- The policy definition containing the logic for your organization Config Custom Policy rule.public String getPolicyText()
The policy definition containing the logic for your organization Config Custom Policy rule.
public OrganizationCustomPolicyRuleMetadata withPolicyText(String policyText)
The policy definition containing the logic for your organization Config Custom Policy rule.
policyText
- The policy definition containing the logic for your organization Config Custom Policy rule.public List<String> getDebugLogDeliveryAccounts()
A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.
public void setDebugLogDeliveryAccounts(Collection<String> debugLogDeliveryAccounts)
A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.
debugLogDeliveryAccounts
- A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List
is null when debug logging is enabled for all accounts.public OrganizationCustomPolicyRuleMetadata withDebugLogDeliveryAccounts(String... debugLogDeliveryAccounts)
A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.
NOTE: This method appends the values to the existing list (if any). Use
setDebugLogDeliveryAccounts(java.util.Collection)
or
withDebugLogDeliveryAccounts(java.util.Collection)
if you want to override the existing values.
debugLogDeliveryAccounts
- A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List
is null when debug logging is enabled for all accounts.public OrganizationCustomPolicyRuleMetadata withDebugLogDeliveryAccounts(Collection<String> debugLogDeliveryAccounts)
A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.
debugLogDeliveryAccounts
- A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List
is null when debug logging is enabled for all accounts.public String toString()
toString
in class Object
Object.toString()
public OrganizationCustomPolicyRuleMetadata clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.