1. Packages
  2. AWS Native
  3. API Docs
  4. fms
  5. Policy

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

aws-native.fms.Policy

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

    Creates an AWS Firewall Manager policy.

    Create Policy Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Policy(name: string, args: PolicyArgs, opts?: CustomResourceOptions);
    @overload
    def Policy(resource_name: str,
               args: PolicyArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Policy(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               remediation_enabled: Optional[bool] = None,
               security_service_policy_data: Optional[PolicySecurityServicePolicyDataArgs] = None,
               exclude_resource_tags: Optional[bool] = None,
               include_map: Optional[PolicyIeMapArgs] = None,
               policy_description: Optional[str] = None,
               policy_name: Optional[str] = None,
               delete_all_policy_resources: Optional[bool] = None,
               resource_set_ids: Optional[Sequence[str]] = None,
               resource_tags: Optional[Sequence[PolicyResourceTagArgs]] = None,
               resource_type: Optional[str] = None,
               resource_type_list: Optional[Sequence[str]] = None,
               resources_clean_up: Optional[bool] = None,
               exclude_map: Optional[PolicyIeMapArgs] = None,
               tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewPolicy(ctx *Context, name string, args PolicyArgs, opts ...ResourceOption) (*Policy, error)
    public Policy(string name, PolicyArgs args, CustomResourceOptions? opts = null)
    public Policy(String name, PolicyArgs args)
    public Policy(String name, PolicyArgs args, CustomResourceOptions options)
    
    type: aws-native:fms:Policy
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args PolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PolicyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const policyResource = new aws_native.fms.Policy("policyResource", {
        remediationEnabled: false,
        securityServicePolicyData: {
            type: aws_native.fms.PolicyType.Waf,
            managedServiceData: "string",
            policyOption: {
                networkFirewallPolicy: {
                    firewallDeploymentModel: aws_native.fms.PolicyFirewallDeploymentModel.Distributed,
                },
                thirdPartyFirewallPolicy: {
                    firewallDeploymentModel: aws_native.fms.PolicyFirewallDeploymentModel.Distributed,
                },
            },
        },
        excludeResourceTags: false,
        includeMap: {
            account: ["string"],
            orgunit: ["string"],
        },
        policyDescription: "string",
        policyName: "string",
        deleteAllPolicyResources: false,
        resourceSetIds: ["string"],
        resourceTags: [{
            key: "string",
            value: "string",
        }],
        resourceType: "string",
        resourceTypeList: ["string"],
        resourcesCleanUp: false,
        excludeMap: {
            account: ["string"],
            orgunit: ["string"],
        },
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    Coming soon!
    

    Policy Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Policy resource accepts the following input properties:

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Policy resource produces the following output properties:

    Arn string
    AwsId string
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    AwsId string
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    awsId String
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    awsId string
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    aws_id str
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    awsId String
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    PolicyFirewallDeploymentModel, PolicyFirewallDeploymentModelArgs

    Distributed
    DISTRIBUTED
    Centralized
    CENTRALIZED
    PolicyFirewallDeploymentModelDistributed
    DISTRIBUTED
    PolicyFirewallDeploymentModelCentralized
    CENTRALIZED
    Distributed
    DISTRIBUTED
    Centralized
    CENTRALIZED
    Distributed
    DISTRIBUTED
    Centralized
    CENTRALIZED
    DISTRIBUTED
    DISTRIBUTED
    CENTRALIZED
    CENTRALIZED
    "DISTRIBUTED"
    DISTRIBUTED
    "CENTRALIZED"
    CENTRALIZED

    PolicyIeMap, PolicyIeMapArgs

    Account List<string>
    Orgunit List<string>
    Account []string
    Orgunit []string
    account List<String>
    orgunit List<String>
    account string[]
    orgunit string[]
    account Sequence[str]
    orgunit Sequence[str]
    account List<String>
    orgunit List<String>

    PolicyNetworkFirewallPolicy, PolicyNetworkFirewallPolicyArgs

    PolicyOption, PolicyOptionArgs

    PolicyResourceTag, PolicyResourceTagArgs

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    PolicySecurityServicePolicyData, PolicySecurityServicePolicyDataArgs

    PolicyThirdPartyFirewallPolicy, PolicyThirdPartyFirewallPolicyArgs

    PolicyType, PolicyTypeArgs

    Waf
    WAF
    Wafv2
    WAFV2
    ShieldAdvanced
    SHIELD_ADVANCED
    SecurityGroupsCommon
    SECURITY_GROUPS_COMMON
    SecurityGroupsContentAudit
    SECURITY_GROUPS_CONTENT_AUDIT
    SecurityGroupsUsageAudit
    SECURITY_GROUPS_USAGE_AUDIT
    NetworkFirewall
    NETWORK_FIREWALL
    ThirdPartyFirewall
    THIRD_PARTY_FIREWALL
    DnsFirewall
    DNS_FIREWALL
    ImportNetworkFirewall
    IMPORT_NETWORK_FIREWALL
    PolicyTypeWaf
    WAF
    PolicyTypeWafv2
    WAFV2
    PolicyTypeShieldAdvanced
    SHIELD_ADVANCED
    PolicyTypeSecurityGroupsCommon
    SECURITY_GROUPS_COMMON
    PolicyTypeSecurityGroupsContentAudit
    SECURITY_GROUPS_CONTENT_AUDIT
    PolicyTypeSecurityGroupsUsageAudit
    SECURITY_GROUPS_USAGE_AUDIT
    PolicyTypeNetworkFirewall
    NETWORK_FIREWALL
    PolicyTypeThirdPartyFirewall
    THIRD_PARTY_FIREWALL
    PolicyTypeDnsFirewall
    DNS_FIREWALL
    PolicyTypeImportNetworkFirewall
    IMPORT_NETWORK_FIREWALL
    Waf
    WAF
    Wafv2
    WAFV2
    ShieldAdvanced
    SHIELD_ADVANCED
    SecurityGroupsCommon
    SECURITY_GROUPS_COMMON
    SecurityGroupsContentAudit
    SECURITY_GROUPS_CONTENT_AUDIT
    SecurityGroupsUsageAudit
    SECURITY_GROUPS_USAGE_AUDIT
    NetworkFirewall
    NETWORK_FIREWALL
    ThirdPartyFirewall
    THIRD_PARTY_FIREWALL
    DnsFirewall
    DNS_FIREWALL
    ImportNetworkFirewall
    IMPORT_NETWORK_FIREWALL
    Waf
    WAF
    Wafv2
    WAFV2
    ShieldAdvanced
    SHIELD_ADVANCED
    SecurityGroupsCommon
    SECURITY_GROUPS_COMMON
    SecurityGroupsContentAudit
    SECURITY_GROUPS_CONTENT_AUDIT
    SecurityGroupsUsageAudit
    SECURITY_GROUPS_USAGE_AUDIT
    NetworkFirewall
    NETWORK_FIREWALL
    ThirdPartyFirewall
    THIRD_PARTY_FIREWALL
    DnsFirewall
    DNS_FIREWALL
    ImportNetworkFirewall
    IMPORT_NETWORK_FIREWALL
    WAF
    WAF
    WAFV2
    WAFV2
    SHIELD_ADVANCED
    SHIELD_ADVANCED
    SECURITY_GROUPS_COMMON
    SECURITY_GROUPS_COMMON
    SECURITY_GROUPS_CONTENT_AUDIT
    SECURITY_GROUPS_CONTENT_AUDIT
    SECURITY_GROUPS_USAGE_AUDIT
    SECURITY_GROUPS_USAGE_AUDIT
    NETWORK_FIREWALL
    NETWORK_FIREWALL
    THIRD_PARTY_FIREWALL
    THIRD_PARTY_FIREWALL
    DNS_FIREWALL
    DNS_FIREWALL
    IMPORT_NETWORK_FIREWALL
    IMPORT_NETWORK_FIREWALL
    "WAF"
    WAF
    "WAFV2"
    WAFV2
    "SHIELD_ADVANCED"
    SHIELD_ADVANCED
    "SECURITY_GROUPS_COMMON"
    SECURITY_GROUPS_COMMON
    "SECURITY_GROUPS_CONTENT_AUDIT"
    SECURITY_GROUPS_CONTENT_AUDIT
    "SECURITY_GROUPS_USAGE_AUDIT"
    SECURITY_GROUPS_USAGE_AUDIT
    "NETWORK_FIREWALL"
    NETWORK_FIREWALL
    "THIRD_PARTY_FIREWALL"
    THIRD_PARTY_FIREWALL
    "DNS_FIREWALL"
    DNS_FIREWALL
    "IMPORT_NETWORK_FIREWALL"
    IMPORT_NETWORK_FIREWALL

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi