« blib/lib/Paws/EC2/CreateTrafficMirrorFilterRuleResult.pm
↑ Summary
blib/lib/Paws/EC2/CreateTrafficMirrorSessionResult.pm »
| 1 | |||
| 2 | package Paws::EC2::CreateTrafficMirrorSession; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has Description => (is => 'ro', isa => 'Str'); | ||
| 6 | has DryRun => (is => 'ro', isa => 'Bool'); | ||
| 7 | has NetworkInterfaceId => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has PacketLength => (is => 'ro', isa => 'Int'); | ||
| 9 | has SessionNumber => (is => 'ro', isa => 'Int', required => 1); | ||
| 10 | has TagSpecifications => (is => 'ro', isa => 'ArrayRef[Paws::EC2::TagSpecification]', traits => ['NameInRequest'], request_name => 'TagSpecification' ); | ||
| 11 | has TrafficMirrorFilterId => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | has TrafficMirrorTargetId => (is => 'ro', isa => 'Str', required => 1); | ||
| 13 | has VirtualNetworkId => (is => 'ro', isa => 'Int'); | ||
| 14 | |||
| 15 | use MooseX::ClassAttribute; | ||
| 16 | |||
| 17 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateTrafficMirrorSession'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::CreateTrafficMirrorSessionResult'); | ||
| 19 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::EC2::CreateTrafficMirrorSession - Arguments for method CreateTrafficMirrorSession on L<Paws::EC2> | ||
| 27 | |||
| 28 | =head1 DESCRIPTION | ||
| 29 | |||
| 30 | This class represents the parameters used for calling the method CreateTrafficMirrorSession on the | ||
| 31 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 32 | as arguments to method CreateTrafficMirrorSession. | ||
| 33 | |||
| 34 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateTrafficMirrorSession. | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | my $ec2 = Paws->service('EC2'); | ||
| 39 | my $CreateTrafficMirrorSessionResult = $ec2->CreateTrafficMirrorSession( | ||
| 40 | NetworkInterfaceId => 'MyNetworkInterfaceId', | ||
| 41 | SessionNumber => 1, | ||
| 42 | TrafficMirrorFilterId => 'MyTrafficMirrorFilterId', | ||
| 43 | TrafficMirrorTargetId => 'MyTrafficMirrorTargetId', | ||
| 44 | ClientToken => 'MyString', # OPTIONAL | ||
| 45 | Description => 'MyString', # OPTIONAL | ||
| 46 | DryRun => 1, # OPTIONAL | ||
| 47 | PacketLength => 1, # OPTIONAL | ||
| 48 | TagSpecifications => [ | ||
| 49 | { | ||
| 50 | ResourceType => 'client-vpn-endpoint' | ||
| 51 | , # values: client-vpn-endpoint, customer-gateway, dedicated-host, dhcp-options, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, internet-gateway, key-pair, launch-template, local-gateway-route-table-vpc-association, natgateway, network-acl, network-interface, network-insights-analysis, network-insights-path, placement-group, reserved-instances, route-table, security-group, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-connect-peer, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log; OPTIONAL | ||
| 52 | Tags => [ | ||
| 53 | { | ||
| 54 | Key => 'MyString', | ||
| 55 | Value => 'MyString', | ||
| 56 | }, | ||
| 57 | ... | ||
| 58 | ], # OPTIONAL | ||
| 59 | }, | ||
| 60 | ... | ||
| 61 | ], # OPTIONAL | ||
| 62 | VirtualNetworkId => 1, # OPTIONAL | ||
| 63 | ); | ||
| 64 | |||
| 65 | # Results: | ||
| 66 | my $ClientToken = $CreateTrafficMirrorSessionResult->ClientToken; | ||
| 67 | my $TrafficMirrorSession = | ||
| 68 | $CreateTrafficMirrorSessionResult->TrafficMirrorSession; | ||
| 69 | |||
| 70 | # Returns a L<Paws::EC2::CreateTrafficMirrorSessionResult> object. | ||
| 71 | |||
| 72 | 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. | ||
| 73 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/CreateTrafficMirrorSession> | ||
| 74 | |||
| 75 | =head1 ATTRIBUTES | ||
| 76 | |||
| 77 | |||
| 78 | =head2 ClientToken => Str | ||
| 79 | |||
| 80 | Unique, case-sensitive identifier that you provide to ensure the | ||
| 81 | idempotency of the request. For more information, see How to Ensure | ||
| 82 | Idempotency | ||
| 83 | (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 Description => Str | ||
| 88 | |||
| 89 | The description of the Traffic Mirror session. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 DryRun => Bool | ||
| 94 | |||
| 95 | Checks whether you have the required permissions for the action, | ||
| 96 | without actually making the request, and provides an error response. If | ||
| 97 | you have the required permissions, the error response is | ||
| 98 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head2 B<REQUIRED> NetworkInterfaceId => Str | ||
| 103 | |||
| 104 | The ID of the source network interface. | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head2 PacketLength => Int | ||
| 109 | |||
| 110 | The number of bytes in each packet to mirror. These are bytes after the | ||
| 111 | VXLAN header. Do not specify this parameter when you want to mirror the | ||
| 112 | entire packet. To mirror a subset of the packet, set this to the length | ||
| 113 | (in bytes) that you want to mirror. For example, if you set this value | ||
| 114 | to 100, then the first 100 bytes that meet the filter criteria are | ||
| 115 | copied to the target. | ||
| 116 | |||
| 117 | If you do not want to mirror the entire packet, use the C<PacketLength> | ||
| 118 | parameter to specify the number of bytes in each packet to mirror. | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | =head2 B<REQUIRED> SessionNumber => Int | ||
| 123 | |||
| 124 | The session number determines the order in which sessions are evaluated | ||
| 125 | when an interface is used by multiple sessions. The first session with | ||
| 126 | a matching filter is the one that mirrors the packets. | ||
| 127 | |||
| 128 | Valid values are 1-32766. | ||
| 129 | |||
| 130 | |||
| 131 | |||
| 132 | =head2 TagSpecifications => ArrayRef[L<Paws::EC2::TagSpecification>] | ||
| 133 | |||
| 134 | The tags to assign to a Traffic Mirror session. | ||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | =head2 B<REQUIRED> TrafficMirrorFilterId => Str | ||
| 139 | |||
| 140 | The ID of the Traffic Mirror filter. | ||
| 141 | |||
| 142 | |||
| 143 | |||
| 144 | =head2 B<REQUIRED> TrafficMirrorTargetId => Str | ||
| 145 | |||
| 146 | The ID of the Traffic Mirror target. | ||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | =head2 VirtualNetworkId => Int | ||
| 151 | |||
| 152 | The VXLAN ID for the Traffic Mirror session. For more information about | ||
| 153 | the VXLAN protocol, see RFC 7348 (https://tools.ietf.org/html/rfc7348). | ||
| 154 | If you do not specify a C<VirtualNetworkId>, an account-wide unique id | ||
| 155 | is chosen at random. | ||
| 156 | |||
| 157 | |||
| 158 | |||
| 159 | |||
| 160 | =head1 SEE ALSO | ||
| 161 | |||
| 162 | This class forms part of L<Paws>, documenting arguments for method CreateTrafficMirrorSession in L<Paws::EC2> | ||
| 163 | |||
| 164 | =head1 BUGS and CONTRIBUTIONS | ||
| 165 | |||
| 166 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 167 | |||
| 168 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 169 | |||
| 170 | =cut | ||
| 171 |