« blib/lib/Paws/EC2/ModifyTrafficMirrorFilterRuleResult.pm
↑ Summary
blib/lib/Paws/EC2/ModifyTrafficMirrorSessionResult.pm »
| 1 | |||
| 2 | package Paws::EC2::ModifyTrafficMirrorSession; | ||
| 3 | use Moose; | ||
| 4 | has Description => (is => 'ro', isa => 'Str'); | ||
| 5 | has DryRun => (is => 'ro', isa => 'Bool'); | ||
| 6 | has PacketLength => (is => 'ro', isa => 'Int'); | ||
| 7 | has RemoveFields => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'RemoveField' ); | ||
| 8 | has SessionNumber => (is => 'ro', isa => 'Int'); | ||
| 9 | has TrafficMirrorFilterId => (is => 'ro', isa => 'Str'); | ||
| 10 | has TrafficMirrorSessionId => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has TrafficMirrorTargetId => (is => 'ro', isa => 'Str'); | ||
| 12 | has VirtualNetworkId => (is => 'ro', isa => 'Int'); | ||
| 13 | |||
| 14 | use MooseX::ClassAttribute; | ||
| 15 | |||
| 16 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyTrafficMirrorSession'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::ModifyTrafficMirrorSessionResult'); | ||
| 18 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::EC2::ModifyTrafficMirrorSession - Arguments for method ModifyTrafficMirrorSession on L<Paws::EC2> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method ModifyTrafficMirrorSession on the | ||
| 30 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 31 | as arguments to method ModifyTrafficMirrorSession. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyTrafficMirrorSession. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $ec2 = Paws->service('EC2'); | ||
| 38 | my $ModifyTrafficMirrorSessionResult = $ec2->ModifyTrafficMirrorSession( | ||
| 39 | TrafficMirrorSessionId => 'MyTrafficMirrorSessionId', | ||
| 40 | Description => 'MyString', # OPTIONAL | ||
| 41 | DryRun => 1, # OPTIONAL | ||
| 42 | PacketLength => 1, # OPTIONAL | ||
| 43 | RemoveFields => [ | ||
| 44 | 'packet-length', | ||
| 45 | ... # values: packet-length, description, virtual-network-id | ||
| 46 | ], # OPTIONAL | ||
| 47 | SessionNumber => 1, # OPTIONAL | ||
| 48 | TrafficMirrorFilterId => 'MyTrafficMirrorFilterId', # OPTIONAL | ||
| 49 | TrafficMirrorTargetId => 'MyTrafficMirrorTargetId', # OPTIONAL | ||
| 50 | VirtualNetworkId => 1, # OPTIONAL | ||
| 51 | ); | ||
| 52 | |||
| 53 | # Results: | ||
| 54 | my $TrafficMirrorSession = | ||
| 55 | $ModifyTrafficMirrorSessionResult->TrafficMirrorSession; | ||
| 56 | |||
| 57 | # Returns a L<Paws::EC2::ModifyTrafficMirrorSessionResult> object. | ||
| 58 | |||
| 59 | 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. | ||
| 60 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/ModifyTrafficMirrorSession> | ||
| 61 | |||
| 62 | =head1 ATTRIBUTES | ||
| 63 | |||
| 64 | |||
| 65 | =head2 Description => Str | ||
| 66 | |||
| 67 | The description to assign to the Traffic Mirror session. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 DryRun => Bool | ||
| 72 | |||
| 73 | Checks whether you have the required permissions for the action, | ||
| 74 | without actually making the request, and provides an error response. If | ||
| 75 | you have the required permissions, the error response is | ||
| 76 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 PacketLength => Int | ||
| 81 | |||
| 82 | The number of bytes in each packet to mirror. These are bytes after the | ||
| 83 | VXLAN header. To mirror a subset, set this to the length (in bytes) to | ||
| 84 | mirror. For example, if you set this value to 100, then the first 100 | ||
| 85 | bytes that meet the filter criteria are copied to the target. Do not | ||
| 86 | specify this parameter when you want to mirror the entire packet. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 RemoveFields => ArrayRef[Str|Undef] | ||
| 91 | |||
| 92 | The properties that you want to remove from the Traffic Mirror session. | ||
| 93 | |||
| 94 | When you remove a property from a Traffic Mirror session, the property | ||
| 95 | is set to the default. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 SessionNumber => Int | ||
| 100 | |||
| 101 | The session number determines the order in which sessions are evaluated | ||
| 102 | when an interface is used by multiple sessions. The first session with | ||
| 103 | a matching filter is the one that mirrors the packets. | ||
| 104 | |||
| 105 | Valid values are 1-32766. | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head2 TrafficMirrorFilterId => Str | ||
| 110 | |||
| 111 | The ID of the Traffic Mirror filter. | ||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | =head2 B<REQUIRED> TrafficMirrorSessionId => Str | ||
| 116 | |||
| 117 | The ID of the Traffic Mirror session. | ||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head2 TrafficMirrorTargetId => Str | ||
| 122 | |||
| 123 | The Traffic Mirror target. The target must be in the same VPC as the | ||
| 124 | source, or have a VPC peering connection with the source. | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head2 VirtualNetworkId => Int | ||
| 129 | |||
| 130 | The virtual network ID of the Traffic Mirror session. | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head1 SEE ALSO | ||
| 136 | |||
| 137 | This class forms part of L<Paws>, documenting arguments for method ModifyTrafficMirrorSession in L<Paws::EC2> | ||
| 138 | |||
| 139 | =head1 BUGS and CONTRIBUTIONS | ||
| 140 | |||
| 141 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 142 | |||
| 143 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 144 | |||
| 145 | =cut | ||
| 146 |