AwsFmsPolicyArgs

interface AwsFmsPolicyArgs { deleteAllPolicyResources?: Input<boolean>; deleteUnusedFmManagedResources?: Input<boolean>; description?: Input<string>; excludeMap?: PolicyExcludeMap; excludeResourceTags: Input<boolean>; includeMap?: PolicyIncludeMap; name: Input<string>; region?: Input<string>; remediationEnabled?: Input<boolean>; resourceSetIds?: Input<Input<string>[]>; resourceSetReferences?: AwsFmsPolicyResourceSetReference[]; resourceSetsCapability?: AwsFmsResourceSetsCapabilityReference; resourceTagLogicalOperator?: Input<string>; resourceTags?: Input<Record<string, Input<string>>>; resourceType?: Input<string>; resourceTypeLists?: Input<Input<string>[]>; securityServicePolicyData?: undefined; securityServicePolicyDataTemplate: AwsFmsPolicySecurityServicePolicyDataTemplateArgs; tags?: Input<Record<string, Input<string>>>; }

Policy input for AwsFms.

Example

CODE
import { type AwsFmsPolicyArgs } from '@jobcloud/aws-fms';

const policyArgs: AwsFmsPolicyArgs = {
  name: 'wafCloudfrontPolicy',
  excludeResourceTags: false,
  resourceType: 'AWS::CloudFront::Distribution',
  securityServicePolicyDataTemplate: {
    path: 'templates/fms-policy/wafv2-cloudfront.json',
  },
};

Properties

deleteAllPolicyResources: Input<boolean>

Whether to delete all policy resources during deletion.

deleteUnusedFmManagedResources: Input<boolean>

Whether to delete unused Firewall Manager managed resources during deletion.

description: Input<string>

Optional policy description.

excludeMap: PolicyExcludeMap

Optional exclude map.

excludeResourceTags: Input<boolean>

Whether policy scope excludes resources with tags.

includeMap: PolicyIncludeMap

Optional include map.

name: Input<string>

Explicit policy purpose input used to build the provider name.

Remarks

Supports Pulumi Input<string> values (literal strings and computed outputs). Literal values are also validated for uniqueness at planning time after stackAndPurpose name construction. Computed values remain supported and are validated when they resolve.

region: Input<string>

Optional region override.

remediationEnabled: Input<boolean>

Whether policy remediation is enabled.

resourceSetIds: Input<Input<string>[]>

Optional referenced FMS resource set IDs.

resourceSetReferences: AwsFmsPolicyResourceSetReference[]

Optional referenced FMS resource sets.

resourceSetsCapability: AwsFmsResourceSetsCapabilityReference

Optional resource-sets capability reference.

Remarks

Provide either a plain object containing resourceSetIds or an AwsFms component instance created with resourceSets, as it exposes the same resourceSetIds shape.

resourceTagLogicalOperator: Input<string>

Optional logical operator for resource tags.

resourceTags: Input<Record<string, Input<string>>>

Optional resource tags used by the policy scope.

resourceType: Input<string>

Single resource type this policy applies to.

resourceTypeLists: Input<Input<string>[]>

Multiple resource types this policy applies to.

securityServicePolicyData: undefined

Direct security-service policy data input is intentionally unsupported. Use securityServicePolicyDataTemplate.

securityServicePolicyDataTemplate: AwsFmsPolicySecurityServicePolicyDataTemplateArgs

FMS managed service policy data template input.

tags: Input<Record<string, Input<string>>>

Optional tags merged with default project/environment tags.