« blib/lib/Paws/NetworkFirewall/CreateFirewall.pm
↑ Summary
blib/lib/Paws/NetworkFirewall/CreateFirewallPolicyResponse.pm »
| 1 | |||
| 2 | package Paws::NetworkFirewall::CreateFirewallPolicy; | ||
| 3 | use Moose; | ||
| 4 | has Description => (is => 'ro', isa => 'Str'); | ||
| 5 | has DryRun => (is => 'ro', isa => 'Bool'); | ||
| 6 | has FirewallPolicy => (is => 'ro', isa => 'Paws::NetworkFirewall::FirewallPolicy', required => 1); | ||
| 7 | has FirewallPolicyName => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::NetworkFirewall::Tag]'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateFirewallPolicy'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::NetworkFirewall::CreateFirewallPolicyResponse'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::NetworkFirewall::CreateFirewallPolicy - Arguments for method CreateFirewallPolicy on L<Paws::NetworkFirewall> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method CreateFirewallPolicy on the | ||
| 26 | L<AWS Network Firewall|Paws::NetworkFirewall> service. Use the attributes of this class | ||
| 27 | as arguments to method CreateFirewallPolicy. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateFirewallPolicy. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $network-firewall = Paws->service('NetworkFirewall'); | ||
| 34 | my $CreateFirewallPolicyResponse = $network -firewall->CreateFirewallPolicy( | ||
| 35 | FirewallPolicy => { | ||
| 36 | StatelessDefaultActions => [ 'MyCollectionMember_String', ... ], | ||
| 37 | StatelessFragmentDefaultActions => [ 'MyCollectionMember_String', ... ], | ||
| 38 | StatefulRuleGroupReferences => [ | ||
| 39 | { | ||
| 40 | ResourceArn => 'MyResourceArn', # min: 1, max: 256 | ||
| 41 | |||
| 42 | }, | ||
| 43 | ... | ||
| 44 | ], # OPTIONAL | ||
| 45 | StatelessCustomActions => [ | ||
| 46 | { | ||
| 47 | ActionDefinition => { | ||
| 48 | PublishMetricAction => { | ||
| 49 | Dimensions => [ | ||
| 50 | { | ||
| 51 | Value => 'MyDimensionValue', # min: 1, max: 128 | ||
| 52 | |||
| 53 | }, | ||
| 54 | ... | ||
| 55 | ], # min: 1, max: 1 | ||
| 56 | |||
| 57 | }, # OPTIONAL | ||
| 58 | }, | ||
| 59 | ActionName => 'MyActionName', # min: 1, max: 128 | ||
| 60 | |||
| 61 | }, | ||
| 62 | ... | ||
| 63 | ], # OPTIONAL | ||
| 64 | StatelessRuleGroupReferences => [ | ||
| 65 | { | ||
| 66 | Priority => 1, # min: 1, max: 65535 | ||
| 67 | ResourceArn => 'MyResourceArn', # min: 1, max: 256 | ||
| 68 | |||
| 69 | }, | ||
| 70 | ... | ||
| 71 | ], # OPTIONAL | ||
| 72 | }, | ||
| 73 | FirewallPolicyName => 'MyResourceName', | ||
| 74 | Description => 'MyDescription', # OPTIONAL | ||
| 75 | DryRun => 1, # OPTIONAL | ||
| 76 | Tags => [ | ||
| 77 | { | ||
| 78 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 79 | Value => 'MyTagValue', # max: 256 | ||
| 80 | |||
| 81 | }, | ||
| 82 | ... | ||
| 83 | ], # OPTIONAL | ||
| 84 | ); | ||
| 85 | |||
| 86 | # Results: | ||
| 87 | my $FirewallPolicyResponse = | ||
| 88 | $CreateFirewallPolicyResponse->FirewallPolicyResponse; | ||
| 89 | my $UpdateToken = $CreateFirewallPolicyResponse->UpdateToken; | ||
| 90 | |||
| 91 | # Returns a L<Paws::NetworkFirewall::CreateFirewallPolicyResponse> object. | ||
| 92 | |||
| 93 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 94 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/network-firewall/CreateFirewallPolicy> | ||
| 95 | |||
| 96 | =head1 ATTRIBUTES | ||
| 97 | |||
| 98 | |||
| 99 | =head2 Description => Str | ||
| 100 | |||
| 101 | A description of the firewall policy. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 DryRun => Bool | ||
| 106 | |||
| 107 | Indicates whether you want Network Firewall to just check the validity | ||
| 108 | of the request, rather than run the request. | ||
| 109 | |||
| 110 | If set to C<TRUE>, Network Firewall checks whether the request can run | ||
| 111 | successfully, but doesn't actually make the requested changes. The call | ||
| 112 | returns the value that the request would return if you ran it with dry | ||
| 113 | run set to C<FALSE>, but doesn't make additions or changes to your | ||
| 114 | resources. This option allows you to make sure that you have the | ||
| 115 | required permissions to run the request and that your request | ||
| 116 | parameters are valid. | ||
| 117 | |||
| 118 | If set to C<FALSE>, Network Firewall makes the requested changes to | ||
| 119 | your resources. | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head2 B<REQUIRED> FirewallPolicy => L<Paws::NetworkFirewall::FirewallPolicy> | ||
| 124 | |||
| 125 | The rule groups and policy actions to use in the firewall policy. | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | =head2 B<REQUIRED> FirewallPolicyName => Str | ||
| 130 | |||
| 131 | The descriptive name of the firewall policy. You can't change the name | ||
| 132 | of a firewall policy after you create it. | ||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | =head2 Tags => ArrayRef[L<Paws::NetworkFirewall::Tag>] | ||
| 137 | |||
| 138 | The key:value pairs to associate with the resource. | ||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | |||
| 143 | =head1 SEE ALSO | ||
| 144 | |||
| 145 | This class forms part of L<Paws>, documenting arguments for method CreateFirewallPolicy in L<Paws::NetworkFirewall> | ||
| 146 | |||
| 147 | =head1 BUGS and CONTRIBUTIONS | ||
| 148 | |||
| 149 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 150 | |||
| 151 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 152 | |||
| 153 | =cut | ||
| 154 |