« blib/lib/Paws/Rekognition/VideoMetadata.pm
↑ Summary
blib/lib/Paws/ResourceGroups/CreateGroupOutput.pm »
| 1 | |||
| 2 | package Paws::ResourceGroups::CreateGroup; | ||
| 3 | use Moose; | ||
| 4 | has Configuration => (is => 'ro', isa => 'ArrayRef[Paws::ResourceGroups::GroupConfigurationItem]'); | ||
| 5 | has Description => (is => 'ro', isa => 'Str'); | ||
| 6 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has ResourceQuery => (is => 'ro', isa => 'Paws::ResourceGroups::ResourceQuery'); | ||
| 8 | has Tags => (is => 'ro', isa => 'Paws::ResourceGroups::Tags'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateGroup'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/groups'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ResourceGroups::CreateGroupOutput'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::ResourceGroups::CreateGroup - Arguments for method CreateGroup on L<Paws::ResourceGroups> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method CreateGroup on the | ||
| 27 | L<AWS Resource Groups|Paws::ResourceGroups> service. Use the attributes of this class | ||
| 28 | as arguments to method CreateGroup. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateGroup. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $resource-groups = Paws->service('ResourceGroups'); | ||
| 35 | my $CreateGroupOutput = $resource -groups->CreateGroup( | ||
| 36 | Name => 'MyGroupName', | ||
| 37 | Configuration => [ | ||
| 38 | { | ||
| 39 | Type => 'MyGroupConfigurationType', # max: 40 | ||
| 40 | Parameters => [ | ||
| 41 | { | ||
| 42 | Name => 'MyGroupConfigurationParameterName', # min: 1, max: 80 | ||
| 43 | Values => [ | ||
| 44 | 'MyGroupConfigurationParameterValue', ... # min: 1, max: 256 | ||
| 45 | ], # OPTIONAL | ||
| 46 | }, | ||
| 47 | ... | ||
| 48 | ], # OPTIONAL | ||
| 49 | }, | ||
| 50 | ... | ||
| 51 | ], # OPTIONAL | ||
| 52 | Description => 'MyDescription', # OPTIONAL | ||
| 53 | ResourceQuery => { | ||
| 54 | Query => 'MyQuery', # max: 4096 | ||
| 55 | Type => 'TAG_FILTERS_1_0' | ||
| 56 | , # values: TAG_FILTERS_1_0, CLOUDFORMATION_STACK_1_0min: 1, max: 128 | ||
| 57 | |||
| 58 | }, # OPTIONAL | ||
| 59 | Tags => { | ||
| 60 | 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256 | ||
| 61 | }, # OPTIONAL | ||
| 62 | ); | ||
| 63 | |||
| 64 | # Results: | ||
| 65 | my $Group = $CreateGroupOutput->Group; | ||
| 66 | my $GroupConfiguration = $CreateGroupOutput->GroupConfiguration; | ||
| 67 | my $ResourceQuery = $CreateGroupOutput->ResourceQuery; | ||
| 68 | my $Tags = $CreateGroupOutput->Tags; | ||
| 69 | |||
| 70 | # Returns a L<Paws::ResourceGroups::CreateGroupOutput> 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/resource-groups/CreateGroup> | ||
| 74 | |||
| 75 | =head1 ATTRIBUTES | ||
| 76 | |||
| 77 | |||
| 78 | =head2 Configuration => ArrayRef[L<Paws::ResourceGroups::GroupConfigurationItem>] | ||
| 79 | |||
| 80 | A configuration associates the resource group with an AWS service and | ||
| 81 | specifies how the service can interact with the resources in the group. | ||
| 82 | A configuration is an array of GroupConfigurationItem elements. For | ||
| 83 | details about the syntax of service configurations, see Service | ||
| 84 | configurations for resource groups | ||
| 85 | (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html). | ||
| 86 | |||
| 87 | A resource group can contain either a C<Configuration> or a | ||
| 88 | C<ResourceQuery>, but not both. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 Description => Str | ||
| 93 | |||
| 94 | The description of the resource group. Descriptions can consist of | ||
| 95 | letters, numbers, hyphens, underscores, periods, and spaces. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 B<REQUIRED> Name => Str | ||
| 100 | |||
| 101 | The name of the group, which is the identifier of the group in other | ||
| 102 | operations. You can't change the name of a resource group after you | ||
| 103 | create it. A resource group name can consist of letters, numbers, | ||
| 104 | hyphens, periods, and underscores. The name cannot start with C<AWS> or | ||
| 105 | C<aws>; these are reserved. A resource group name must be unique within | ||
| 106 | each AWS Region in your AWS account. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 ResourceQuery => L<Paws::ResourceGroups::ResourceQuery> | ||
| 111 | |||
| 112 | The resource query that determines which AWS resources are members of | ||
| 113 | this group. For more information about resource queries, see Create a | ||
| 114 | tag-based group in Resource Groups | ||
| 115 | (https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag). | ||
| 116 | |||
| 117 | A resource group can contain either a C<ResourceQuery> or a | ||
| 118 | C<Configuration>, but not both. | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | =head2 Tags => L<Paws::ResourceGroups::Tags> | ||
| 123 | |||
| 124 | The tags to add to the group. A tag is key-value pair string. | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | =head1 SEE ALSO | ||
| 130 | |||
| 131 | This class forms part of L<Paws>, documenting arguments for method CreateGroup in L<Paws::ResourceGroups> | ||
| 132 | |||
| 133 | =head1 BUGS and CONTRIBUTIONS | ||
| 134 | |||
| 135 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 136 | |||
| 137 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 138 | |||
| 139 | =cut | ||
| 140 |