« blib/lib/Paws/FMS/SecurityGroupRuleDescription.pm
↑ Summary
blib/lib/Paws/FMS/StatefulRuleGroup.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::FMS::SecurityServicePolicyData; | ||
| 3 | use Moose; | ||
| 4 | has ManagedServiceData => (is => 'ro', isa => 'Str'); | ||
| 5 | has Type => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::FMS::SecurityServicePolicyData | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::FMS::SecurityServicePolicyData object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { ManagedServiceData => $value, ..., Type => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::FMS::SecurityServicePolicyData object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->ManagedServiceData | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Details about the security service that is being used to protect the | ||
| 38 | resources. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 ManagedServiceData => Str | ||
| 44 | |||
| 45 | Details about the service that are specific to the service type, in | ||
| 46 | JSON format. For service type C<SHIELD_ADVANCED>, this is an empty | ||
| 47 | string. | ||
| 48 | |||
| 49 | =over | ||
| 50 | |||
| 51 | =item * | ||
| 52 | |||
| 53 | Example: C<NETWORK_FIREWALL> | ||
| 54 | |||
| 55 | C<"{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-west-1:1234567891011:stateless-rulegroup/rulegroup2\",\"priority\":10}],\"networkFirewallStatelessDefaultActions\":[\"aws:pass\",\"custom1\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"custom2\",\"aws:pass\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"custom1\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"dimension1\"}]}}},{\"actionName\":\"custom2\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"dimension2\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-west-1:1234567891011:stateful-rulegroup/rulegroup1\"}],\"networkFirewallOrchestrationConfig\":{\"singleFirewallEndpointPerVPC\":true,\"allowedIPV4CidrList\":[\"10.24.34.0/28\"]} | ||
| 56 | }"> | ||
| 57 | |||
| 58 | =item * | ||
| 59 | |||
| 60 | Example: C<WAFV2> | ||
| 61 | |||
| 62 | C<"{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"version\":null,\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesAmazonIpReputationList\"},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[]}],\"postProcessRuleGroups\":[],\"defaultAction\":{\"type\":\"ALLOW\"},\"overrideCustomerWebACLAssociation\":false,\"loggingConfiguration\":{\"logDestinationConfigs\":[\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\"],\"redactedFields\":[{\"redactedFieldType\":\"SingleHeader\",\"redactedFieldValue\":\"Cookies\"},{\"redactedFieldType\":\"Method\"}]}}"> | ||
| 63 | |||
| 64 | In the C<loggingConfiguration>, you can specify one | ||
| 65 | C<logDestinationConfigs>, you can optionally provide up to 20 | ||
| 66 | C<redactedFields>, and the C<RedactedFieldType> must be one of C<URI>, | ||
| 67 | C<QUERY_STRING>, C<HEADER>, or C<METHOD>. | ||
| 68 | |||
| 69 | =item * | ||
| 70 | |||
| 71 | Example: C<WAF Classic> | ||
| 72 | |||
| 73 | C<"{\"type\": \"WAF\", \"ruleGroups\": | ||
| 74 | [{\"id\":\"12345678-1bcd-9012-efga-0987654321ab\", \"overrideAction\" : | ||
| 75 | {\"type\": \"COUNT\"}}], \"defaultAction\": {\"type\": \"BLOCK\"}}"> | ||
| 76 | |||
| 77 | =item * | ||
| 78 | |||
| 79 | Example: C<SECURITY_GROUPS_COMMON> | ||
| 80 | |||
| 81 | C<"{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false, | ||
| 82 | \"applyToAllEC2InstanceENIs\":false,\"securityGroups\":[{\"id\":\" | ||
| 83 | sg-000e55995d61a06bd\"}]}"> | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | Example: C<SECURITY_GROUPS_CONTENT_AUDIT> | ||
| 88 | |||
| 89 | C<"{\"type\":\"SECURITY_GROUPS_CONTENT_AUDIT\",\"securityGroups\":[{\"id\":\"sg-000e55995d61a06bd\"}],\"securityGroupAction\":{\"type\":\"ALLOW\"}}"> | ||
| 90 | |||
| 91 | The security group action for content audit can be C<ALLOW> or C<DENY>. | ||
| 92 | For C<ALLOW>, all in-scope security group rules must be within the | ||
| 93 | allowed range of the policy's security group rules. For C<DENY>, all | ||
| 94 | in-scope security group rules must not contain a value or a range that | ||
| 95 | matches a rule value or range in the policy security group. | ||
| 96 | |||
| 97 | =item * | ||
| 98 | |||
| 99 | Example: C<SECURITY_GROUPS_USAGE_AUDIT> | ||
| 100 | |||
| 101 | C<"{\"type\":\"SECURITY_GROUPS_USAGE_AUDIT\",\"deleteUnusedSecurityGroups\":true,\"coalesceRedundantSecurityGroups\":true}"> | ||
| 102 | |||
| 103 | =back | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 B<REQUIRED> Type => Str | ||
| 108 | |||
| 109 | The service that the policy is using to protect the resources. This | ||
| 110 | specifies the type of policy that is created, either an AWS WAF policy, | ||
| 111 | a Shield Advanced policy, or a security group policy. For security | ||
| 112 | group policies, Firewall Manager supports one security group for each | ||
| 113 | common policy and for each content audit policy. This is an adjustable | ||
| 114 | limit that you can increase by contacting AWS Support. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head1 SEE ALSO | ||
| 119 | |||
| 120 | This class forms part of L<Paws>, describing an object used in L<Paws::FMS> | ||
| 121 | |||
| 122 | =head1 BUGS and CONTRIBUTIONS | ||
| 123 | |||
| 124 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 125 | |||
| 126 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 127 | |||
| 128 | =cut | ||
| 129 |