software.amazon.awssdk.services.config.model

Interface OrganizationCustomRuleMetadata.Builder

All Superinterfaces:

Buildable, CopyableBuilder<OrganizationCustomRuleMetadata.Builder,OrganizationCustomRuleMetadata>, SdkBuilder<OrganizationCustomRuleMetadata.Builder,OrganizationCustomRuleMetadata>, SdkPojo

Enclosing class:

OrganizationCustomRuleMetadata

public static interface OrganizationCustomRuleMetadata.Builder
extends SdkPojo, CopyableBuilder<OrganizationCustomRuleMetadata.Builder,OrganizationCustomRuleMetadata>

Method Summary

Modifier and Type	Method and Description
OrganizationCustomRuleMetadata.Builder	description(String description) The description that you provide for your organization Config rule.
OrganizationCustomRuleMetadata.Builder	inputParameters(String inputParameters) A string, in JSON format, that is passed to your organization Config rule Lambda function.
OrganizationCustomRuleMetadata.Builder	lambdaFunctionArn(String lambdaFunctionArn) The lambda function ARN.
OrganizationCustomRuleMetadata.Builder	maximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency) The maximum frequency with which Config runs evaluations for a rule.
OrganizationCustomRuleMetadata.Builder	maximumExecutionFrequency(String maximumExecutionFrequency) The maximum frequency with which Config runs evaluations for a rule.
OrganizationCustomRuleMetadata.Builder	organizationConfigRuleTriggerTypes(Collection<OrganizationConfigRuleTriggerType> organizationConfigRuleTriggerTypes) The type of notification that triggers Config to run an evaluation for a rule.
OrganizationCustomRuleMetadata.Builder	organizationConfigRuleTriggerTypes(OrganizationConfigRuleTriggerType... organizationConfigRuleTriggerTypes) The type of notification that triggers Config to run an evaluation for a rule.
OrganizationCustomRuleMetadata.Builder	organizationConfigRuleTriggerTypesWithStrings(Collection<String> organizationConfigRuleTriggerTypes) The type of notification that triggers Config to run an evaluation for a rule.
OrganizationCustomRuleMetadata.Builder	organizationConfigRuleTriggerTypesWithStrings(String... organizationConfigRuleTriggerTypes) The type of notification that triggers Config to run an evaluation for a rule.
OrganizationCustomRuleMetadata.Builder	resourceIdScope(String resourceIdScope) The ID of the Amazon Web Services resource that was evaluated.
OrganizationCustomRuleMetadata.Builder	resourceTypesScope(Collection<String> resourceTypesScope) The type of the Amazon Web Services resource that was evaluated.
OrganizationCustomRuleMetadata.Builder	resourceTypesScope(String... resourceTypesScope) The type of the Amazon Web Services resource that was evaluated.
OrganizationCustomRuleMetadata.Builder	tagKeyScope(String tagKeyScope) One part of a key-value pair that make up a tag.
OrganizationCustomRuleMetadata.Builder	tagValueScope(String tagValueScope) The optional part of a key-value pair that make up a tag.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

description

OrganizationCustomRuleMetadata.Builder description(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.

lambdaFunctionArn

OrganizationCustomRuleMetadata.Builder lambdaFunctionArn(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.

organizationConfigRuleTriggerTypesWithStrings

OrganizationCustomRuleMetadata.Builder organizationConfigRuleTriggerTypesWithStrings(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.

organizationConfigRuleTriggerTypesWithStrings

OrganizationCustomRuleMetadata.Builder organizationConfigRuleTriggerTypesWithStrings(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.

organizationConfigRuleTriggerTypes

OrganizationCustomRuleMetadata.Builder organizationConfigRuleTriggerTypes(Collection<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.

organizationConfigRuleTriggerTypes

OrganizationCustomRuleMetadata.Builder organizationConfigRuleTriggerTypes(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.

inputParameters

OrganizationCustomRuleMetadata.Builder inputParameters(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.

maximumExecutionFrequency

OrganizationCustomRuleMetadata.Builder maximumExecutionFrequency(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, MaximumExecutionFrequency

maximumExecutionFrequency

OrganizationCustomRuleMetadata.Builder maximumExecutionFrequency(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, MaximumExecutionFrequency

resourceTypesScope

OrganizationCustomRuleMetadata.Builder resourceTypesScope(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.

resourceTypesScope

OrganizationCustomRuleMetadata.Builder resourceTypesScope(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.

resourceIdScope

OrganizationCustomRuleMetadata.Builder resourceIdScope(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.

tagKeyScope

OrganizationCustomRuleMetadata.Builder tagKeyScope(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.

tagValueScope

OrganizationCustomRuleMetadata.Builder tagValueScope(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.