Struct aws_sdk_config::client::fluent_builders::PutOrganizationConfigRule

pub struct PutOrganizationConfigRule { /* private fields */ }

Fluent builder constructing a request to PutOrganizationConfigRule.

Adds or updates an Config rule for your entire organization to evaluate if your Amazon Web Services resources comply with your desired configurations. For information on how many organization Config rules you can have per account, see Service Limits in the Config Developer Guide.

Only a master account and a delegated administrator can create or update an organization Config rule. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator permissions are added. An organization can have up to 3 delegated administrators.

This API enables organization service access through the EnableAWSServiceAccess action and creates a service-linked role AWSServiceRoleForConfigMultiAccountSetup in the master or delegated administrator account of your organization. The service-linked role is created only when the role does not exist in the caller account. Config verifies the existence of role with GetRole action.

To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization register-delegated-administrator for config-multiaccountsetup.amazonaws.com.

There are two types of rules: Config Custom Rules and Config Managed Rules. You can use PutOrganizationConfigRule to create both Config custom rules and Config managed rules.

Custom rules are rules that you can create using either Guard or Lambda functions. Guard (Guard GitHub Repository) is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. Lambda uses custom code that you upload to evaluate a custom rule. If you are adding a new Custom Lambda rule, you first need to create an Lambda function in the master account or a delegated administrator that the rule invokes to evaluate your resources. You also need to create an IAM role in the managed account that can be assumed by the Lambda function. When you use PutOrganizationConfigRule to add a Custom Lambda rule to Config, you must specify the Amazon Resource Name (ARN) that Lambda assigns to the function.

Managed rules are predefined, customizable rules created by Config. For a list of managed rules, see List of Config Managed Rules. If you are adding an Config managed rule, you must specify the rule's identifier for the RuleIdentifier key.

Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization.

Make sure to specify one of either OrganizationCustomPolicyRuleMetadata for Custom Policy rules, OrganizationCustomRuleMetadata for Custom Lambda rules, or OrganizationManagedRuleMetadata for managed rules.

Implementations

impl PutOrganizationConfigRule

pub async fn customize(
    self
) -> Result<CustomizableOperation<PutOrganizationConfigRule, AwsResponseRetryClassifier>, SdkError<PutOrganizationConfigRuleError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<PutOrganizationConfigRuleOutput, SdkError<PutOrganizationConfigRuleError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn organization_config_rule_name(self, input: impl Into<String>) -> Self

The name that you assign to an organization Config rule.

pub fn set_organization_config_rule_name(self, input: Option<String>) -> Self

The name that you assign to an organization Config rule.

pub fn organization_managed_rule_metadata(
    self,
    input: OrganizationManagedRuleMetadata
) -> Self

An OrganizationManagedRuleMetadata object. This object 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.

pub fn set_organization_managed_rule_metadata(
    self,
    input: Option<OrganizationManagedRuleMetadata>
) -> Self

An OrganizationManagedRuleMetadata object. This object 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.

pub fn organization_custom_rule_metadata(
    self,
    input: OrganizationCustomRuleMetadata
) -> Self

An OrganizationCustomRuleMetadata object. This object specifies 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.

pub fn set_organization_custom_rule_metadata(
    self,
    input: Option<OrganizationCustomRuleMetadata>
) -> Self

An OrganizationCustomRuleMetadata object. This object specifies 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.

pub fn excluded_accounts(self, input: impl Into<String>) -> Self

Appends an item to ExcludedAccounts.

To override the contents of this collection use set_excluded_accounts.

A comma-separated list of accounts that you want to exclude from an organization Config rule.

pub fn set_excluded_accounts(self, input: Option<Vec<String>>) -> Self

A comma-separated list of accounts that you want to exclude from an organization Config rule.

pub fn organization_custom_policy_rule_metadata(
    self,
    input: OrganizationCustomPolicyRuleMetadata
) -> Self

An OrganizationCustomPolicyRuleMetadata object. This object 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.

pub fn set_organization_custom_policy_rule_metadata(
    self,
    input: Option<OrganizationCustomPolicyRuleMetadata>
) -> Self

An OrganizationCustomPolicyRuleMetadata object. This object 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.

Trait Implementations

impl Clone for PutOrganizationConfigRule

fn clone(&self) -> PutOrganizationConfigRule

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PutOrganizationConfigRule

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.