| 1 | |||
| 2 | package Paws::XRay::CreateGroup; | ||
| 3 | use Moose; | ||
| 4 | has FilterExpression => (is => 'ro', isa => 'Str'); | ||
| 5 | has GroupName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has InsightsConfiguration => (is => 'ro', isa => 'Paws::XRay::InsightsConfiguration'); | ||
| 7 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::XRay::Tag]'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateGroup'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/CreateGroup'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::XRay::CreateGroupResult'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::XRay::CreateGroup - Arguments for method CreateGroup on L<Paws::XRay> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method CreateGroup on the | ||
| 26 | L<AWS X-Ray|Paws::XRay> service. Use the attributes of this class | ||
| 27 | as arguments to method CreateGroup. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateGroup. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $xray = Paws->service('XRay'); | ||
| 34 | my $CreateGroupResult = $xray->CreateGroup( | ||
| 35 | GroupName => 'MyGroupName', | ||
| 36 | FilterExpression => 'MyFilterExpression', # OPTIONAL | ||
| 37 | InsightsConfiguration => { | ||
| 38 | InsightsEnabled => 1, # OPTIONAL | ||
| 39 | NotificationsEnabled => 1, # OPTIONAL | ||
| 40 | }, # OPTIONAL | ||
| 41 | Tags => [ | ||
| 42 | { | ||
| 43 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 44 | Value => 'MyTagValue', # max: 256 | ||
| 45 | |||
| 46 | }, | ||
| 47 | ... | ||
| 48 | ], # OPTIONAL | ||
| 49 | ); | ||
| 50 | |||
| 51 | # Results: | ||
| 52 | my $Group = $CreateGroupResult->Group; | ||
| 53 | |||
| 54 | # Returns a L<Paws::XRay::CreateGroupResult> object. | ||
| 55 | |||
| 56 | 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. | ||
| 57 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/xray/CreateGroup> | ||
| 58 | |||
| 59 | =head1 ATTRIBUTES | ||
| 60 | |||
| 61 | |||
| 62 | =head2 FilterExpression => Str | ||
| 63 | |||
| 64 | The filter expression defining criteria by which to group traces. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> GroupName => Str | ||
| 69 | |||
| 70 | The case-sensitive name of the new group. Default is a reserved name | ||
| 71 | and names must be unique. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 InsightsConfiguration => L<Paws::XRay::InsightsConfiguration> | ||
| 76 | |||
| 77 | The structure containing configurations related to insights. | ||
| 78 | |||
| 79 | =over | ||
| 80 | |||
| 81 | =item * | ||
| 82 | |||
| 83 | The InsightsEnabled boolean can be set to true to enable insights for | ||
| 84 | the new group or false to disable insights for the new group. | ||
| 85 | |||
| 86 | =item * | ||
| 87 | |||
| 88 | The NotifcationsEnabled boolean can be set to true to enable insights | ||
| 89 | notifications for the new group. Notifications may only be enabled on a | ||
| 90 | group with InsightsEnabled set to true. | ||
| 91 | |||
| 92 | =back | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 Tags => ArrayRef[L<Paws::XRay::Tag>] | ||
| 98 | |||
| 99 | A map that contains one or more tag keys and tag values to attach to an | ||
| 100 | X-Ray group. For more information about ways to use tags, see Tagging | ||
| 101 | AWS resources | ||
| 102 | (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the | ||
| 103 | I<AWS General Reference>. | ||
| 104 | |||
| 105 | The following restrictions apply to tags: | ||
| 106 | |||
| 107 | =over | ||
| 108 | |||
| 109 | =item * | ||
| 110 | |||
| 111 | Maximum number of user-applied tags per resource: 50 | ||
| 112 | |||
| 113 | =item * | ||
| 114 | |||
| 115 | Maximum tag key length: 128 Unicode characters | ||
| 116 | |||
| 117 | =item * | ||
| 118 | |||
| 119 | Maximum tag value length: 256 Unicode characters | ||
| 120 | |||
| 121 | =item * | ||
| 122 | |||
| 123 | Valid values for key and value: a-z, A-Z, 0-9, space, and the following | ||
| 124 | characters: _ . : / = + - and @ | ||
| 125 | |||
| 126 | =item * | ||
| 127 | |||
| 128 | Tag keys and values are case sensitive. | ||
| 129 | |||
| 130 | =item * | ||
| 131 | |||
| 132 | Don't use C<aws:> as a prefix for keys; it's reserved for AWS use. | ||
| 133 | |||
| 134 | =back | ||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | |||
| 139 | |||
| 140 | =head1 SEE ALSO | ||
| 141 | |||
| 142 | This class forms part of L<Paws>, documenting arguments for method CreateGroup in L<Paws::XRay> | ||
| 143 | |||
| 144 | =head1 BUGS and CONTRIBUTIONS | ||
| 145 | |||
| 146 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 147 | |||
| 148 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 149 | |||
| 150 | =cut | ||
| 151 |