« blib/lib/Paws/IoTThingsGraph/CreateFlowTemplateResponse.pm
↑ Summary
blib/lib/Paws/IoTThingsGraph/CreateSystemInstanceResponse.pm »
| 1 | |||
| 2 | package Paws::IoTThingsGraph::CreateSystemInstance; | ||
| 3 | use Moose; | ||
| 4 | has Definition => (is => 'ro', isa => 'Paws::IoTThingsGraph::DefinitionDocument', traits => ['NameInRequest'], request_name => 'definition' , required => 1); | ||
| 5 | has FlowActionsRoleArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'flowActionsRoleArn' ); | ||
| 6 | has GreengrassGroupName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'greengrassGroupName' ); | ||
| 7 | has MetricsConfiguration => (is => 'ro', isa => 'Paws::IoTThingsGraph::MetricsConfiguration', traits => ['NameInRequest'], request_name => 'metricsConfiguration' ); | ||
| 8 | has S3BucketName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 's3BucketName' ); | ||
| 9 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::IoTThingsGraph::Tag]', traits => ['NameInRequest'], request_name => 'tags' ); | ||
| 10 | has Target => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'target' , required => 1); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateSystemInstance'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTThingsGraph::CreateSystemInstanceResponse'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::IoTThingsGraph::CreateSystemInstance - Arguments for method CreateSystemInstance on L<Paws::IoTThingsGraph> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method CreateSystemInstance on the | ||
| 28 | L<AWS IoT Things Graph|Paws::IoTThingsGraph> service. Use the attributes of this class | ||
| 29 | as arguments to method CreateSystemInstance. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateSystemInstance. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $iotthingsgraph = Paws->service('IoTThingsGraph'); | ||
| 36 | my $CreateSystemInstanceResponse = $iotthingsgraph->CreateSystemInstance( | ||
| 37 | Definition => { | ||
| 38 | Language => 'GRAPHQL', # values: GRAPHQL | ||
| 39 | Text => 'MyDefinitionText', # max: 1048576 | ||
| 40 | |||
| 41 | }, | ||
| 42 | Target => 'GREENGRASS', | ||
| 43 | FlowActionsRoleArn => 'MyRoleArn', # OPTIONAL | ||
| 44 | GreengrassGroupName => 'MyGroupName', # OPTIONAL | ||
| 45 | MetricsConfiguration => { | ||
| 46 | CloudMetricEnabled => 1, # OPTIONAL | ||
| 47 | MetricRuleRoleArn => 'MyRoleArn', # min: 20, max: 2048 | ||
| 48 | }, # OPTIONAL | ||
| 49 | S3BucketName => 'MyS3BucketName', # OPTIONAL | ||
| 50 | Tags => [ | ||
| 51 | { | ||
| 52 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 53 | Value => 'MyTagValue', # min: 1, max: 256 | ||
| 54 | |||
| 55 | }, | ||
| 56 | ... | ||
| 57 | ], # OPTIONAL | ||
| 58 | ); | ||
| 59 | |||
| 60 | # Results: | ||
| 61 | my $Summary = $CreateSystemInstanceResponse->Summary; | ||
| 62 | |||
| 63 | # Returns a L<Paws::IoTThingsGraph::CreateSystemInstanceResponse> object. | ||
| 64 | |||
| 65 | 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. | ||
| 66 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph/CreateSystemInstance> | ||
| 67 | |||
| 68 | =head1 ATTRIBUTES | ||
| 69 | |||
| 70 | |||
| 71 | =head2 B<REQUIRED> Definition => L<Paws::IoTThingsGraph::DefinitionDocument> | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 FlowActionsRoleArn => Str | ||
| 78 | |||
| 79 | The ARN of the IAM role that AWS IoT Things Graph will assume when it | ||
| 80 | executes the flow. This role must have read and write access to AWS | ||
| 81 | Lambda and AWS IoT and any other AWS services that the flow uses when | ||
| 82 | it executes. This value is required if the value of the C<target> | ||
| 83 | parameter is C<CLOUD>. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 GreengrassGroupName => Str | ||
| 88 | |||
| 89 | The name of the Greengrass group where the system instance will be | ||
| 90 | deployed. This value is required if the value of the C<target> | ||
| 91 | parameter is C<GREENGRASS>. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head2 MetricsConfiguration => L<Paws::IoTThingsGraph::MetricsConfiguration> | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 S3BucketName => Str | ||
| 102 | |||
| 103 | The name of the Amazon Simple Storage Service bucket that will be used | ||
| 104 | to store and deploy the system instance's resource file. This value is | ||
| 105 | required if the value of the C<target> parameter is C<GREENGRASS>. | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head2 Tags => ArrayRef[L<Paws::IoTThingsGraph::Tag>] | ||
| 110 | |||
| 111 | Metadata, consisting of key-value pairs, that can be used to categorize | ||
| 112 | your system instances. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 B<REQUIRED> Target => Str | ||
| 117 | |||
| 118 | The target type of the deployment. Valid values are C<GREENGRASS> and | ||
| 119 | C<CLOUD>. | ||
| 120 | |||
| 121 | Valid values are: C<"GREENGRASS">, C<"CLOUD"> | ||
| 122 | |||
| 123 | |||
| 124 | =head1 SEE ALSO | ||
| 125 | |||
| 126 | This class forms part of L<Paws>, documenting arguments for method CreateSystemInstance in L<Paws::IoTThingsGraph> | ||
| 127 | |||
| 128 | =head1 BUGS and CONTRIBUTIONS | ||
| 129 | |||
| 130 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 131 | |||
| 132 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 133 | |||
| 134 | =cut | ||
| 135 |