Class OrganizationCustomPolicyRuleMetadataNoPolicy

    • Method Detail

      • description

        public final String description()

        The description that you provide for your organization Config Custom Policy rule.

        Returns:
        The description that you provide for your organization Config Custom Policy rule.
      • organizationConfigRuleTriggerTypes

        public final List<OrganizationConfigRuleTriggerTypeNoSN> organizationConfigRuleTriggerTypes()

        The type of notification that triggers Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change triggered 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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOrganizationConfigRuleTriggerTypes() method.

        Returns:
        The type of notification that triggers Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change triggered 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.

      • hasOrganizationConfigRuleTriggerTypes

        public final boolean hasOrganizationConfigRuleTriggerTypes()
        For responses, this returns true if the service returned a value for the OrganizationConfigRuleTriggerTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • organizationConfigRuleTriggerTypesAsStrings

        public final List<String> organizationConfigRuleTriggerTypesAsStrings()

        The type of notification that triggers Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change triggered 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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOrganizationConfigRuleTriggerTypes() method.

        Returns:
        The type of notification that triggers Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change triggered 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.

      • inputParameters

        public final String inputParameters()

        A string, in JSON format, that is passed to your organization Config Custom Policy rule.

        Returns:
        A string, in JSON format, that is passed to your organization Config Custom Policy rule.
      • hasResourceTypesScope

        public final boolean hasResourceTypesScope()
        For responses, this returns true if the service returned a value for the ResourceTypesScope property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • resourceTypesScope

        public final List<String> resourceTypesScope()

        The type of the Amazon Web Services resource that was evaluated.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResourceTypesScope() method.

        Returns:
        The type of the Amazon Web Services resource that was evaluated.
      • resourceIdScope

        public final String resourceIdScope()

        The ID of the Amazon Web Services resource that was evaluated.

        Returns:
        The ID of the Amazon Web Services resource that was evaluated.
      • tagKeyScope

        public final 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.

        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.
      • tagValueScope

        public final 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).

        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).
      • policyRuntime

        public final 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.

        Returns:
        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.
      • hasDebugLogDeliveryAccounts

        public final boolean hasDebugLogDeliveryAccounts()
        For responses, this returns true if the service returned a value for the DebugLogDeliveryAccounts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • debugLogDeliveryAccounts

        public final List<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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDebugLogDeliveryAccounts() method.

        Returns:
        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.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final 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
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)