« blib/lib/Paws/CloudDirectory/CreateDirectoryResponse.pm
↑ Summary
blib/lib/Paws/CloudDirectory/CreateFacetResponse.pm »
| 1 | |||
| 2 | package Paws::CloudDirectory::CreateFacet; | ||
| 3 | use Moose; | ||
| 4 | has Attributes => (is => 'ro', isa => 'ArrayRef[Paws::CloudDirectory::FacetAttribute]'); | ||
| 5 | has FacetStyle => (is => 'ro', isa => 'Str'); | ||
| 6 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has ObjectType => (is => 'ro', isa => 'Str'); | ||
| 8 | has SchemaArn => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-data-partition', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateFacet'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/amazonclouddirectory/2017-01-11/facet/create'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudDirectory::CreateFacetResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::CloudDirectory::CreateFacet - Arguments for method CreateFacet on L<Paws::CloudDirectory> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method CreateFacet on the | ||
| 27 | L<Amazon CloudDirectory|Paws::CloudDirectory> service. Use the attributes of this class | ||
| 28 | as arguments to method CreateFacet. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateFacet. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $clouddirectory = Paws->service('CloudDirectory'); | ||
| 35 | my $CreateFacetResponse = $clouddirectory->CreateFacet( | ||
| 36 | Name => 'MyFacetName', | ||
| 37 | SchemaArn => 'MyArn', | ||
| 38 | Attributes => [ | ||
| 39 | { | ||
| 40 | Name => 'MyAttributeName', # min: 1, max: 230 | ||
| 41 | AttributeDefinition => { | ||
| 42 | Type => 'STRING' | ||
| 43 | , # values: STRING, BINARY, BOOLEAN, NUMBER, DATETIME, VARIANT | ||
| 44 | DefaultValue => { | ||
| 45 | BinaryValue => 'BlobBinaryAttributeValue', # OPTIONAL | ||
| 46 | BooleanValue => 1, # OPTIONAL | ||
| 47 | DatetimeValue => '1970-01-01T01:00:00', # OPTIONAL | ||
| 48 | NumberValue => 'MyNumberAttributeValue', # OPTIONAL | ||
| 49 | StringValue => 'MyStringAttributeValue', # OPTIONAL | ||
| 50 | }, # OPTIONAL | ||
| 51 | IsImmutable => 1, # OPTIONAL | ||
| 52 | Rules => { | ||
| 53 | 'MyRuleKey' => { | ||
| 54 | Parameters => | ||
| 55 | { 'MyRuleParameterKey' => 'MyRuleParameterValue', } | ||
| 56 | , # OPTIONAL | ||
| 57 | Type => 'BINARY_LENGTH' | ||
| 58 | , # values: BINARY_LENGTH, NUMBER_COMPARISON, STRING_FROM_SET, STRING_LENGTH; OPTIONAL | ||
| 59 | }, # key: min: 1, max: 64 | ||
| 60 | }, # OPTIONAL | ||
| 61 | }, # OPTIONAL | ||
| 62 | AttributeReference => { | ||
| 63 | TargetAttributeName => 'MyAttributeName', # min: 1, max: 230 | ||
| 64 | TargetFacetName => 'MyFacetName', # min: 1, max: 64 | ||
| 65 | |||
| 66 | }, # OPTIONAL | ||
| 67 | RequiredBehavior => | ||
| 68 | 'REQUIRED_ALWAYS', # values: REQUIRED_ALWAYS, NOT_REQUIRED; OPTIONAL | ||
| 69 | }, | ||
| 70 | ... | ||
| 71 | ], # OPTIONAL | ||
| 72 | FacetStyle => 'STATIC', # OPTIONAL | ||
| 73 | ObjectType => 'NODE', # OPTIONAL | ||
| 74 | ); | ||
| 75 | |||
| 76 | 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. | ||
| 77 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/clouddirectory/CreateFacet> | ||
| 78 | |||
| 79 | =head1 ATTRIBUTES | ||
| 80 | |||
| 81 | |||
| 82 | =head2 Attributes => ArrayRef[L<Paws::CloudDirectory::FacetAttribute>] | ||
| 83 | |||
| 84 | The attributes that are associated with the Facet. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 FacetStyle => Str | ||
| 89 | |||
| 90 | There are two different styles that you can define on any given facet, | ||
| 91 | C<Static> and C<Dynamic>. For static facets, all attributes must be | ||
| 92 | defined in the schema. For dynamic facets, attributes can be defined | ||
| 93 | during data plane operations. | ||
| 94 | |||
| 95 | Valid values are: C<"STATIC">, C<"DYNAMIC"> | ||
| 96 | |||
| 97 | =head2 B<REQUIRED> Name => Str | ||
| 98 | |||
| 99 | The name of the Facet, which is unique for a given schema. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 ObjectType => Str | ||
| 104 | |||
| 105 | Specifies whether a given object created from this facet is of type | ||
| 106 | node, leaf node, policy or index. | ||
| 107 | |||
| 108 | =over | ||
| 109 | |||
| 110 | =item * | ||
| 111 | |||
| 112 | Node: Can have multiple children but one parent. | ||
| 113 | |||
| 114 | =back | ||
| 115 | |||
| 116 | =over | ||
| 117 | |||
| 118 | =item * | ||
| 119 | |||
| 120 | Leaf node: Cannot have children but can have multiple parents. | ||
| 121 | |||
| 122 | =back | ||
| 123 | |||
| 124 | =over | ||
| 125 | |||
| 126 | =item * | ||
| 127 | |||
| 128 | Policy: Allows you to store a policy document and policy type. For more | ||
| 129 | information, see Policies | ||
| 130 | (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies). | ||
| 131 | |||
| 132 | =back | ||
| 133 | |||
| 134 | =over | ||
| 135 | |||
| 136 | =item * | ||
| 137 | |||
| 138 | Index: Can be created with the Index API. | ||
| 139 | |||
| 140 | =back | ||
| 141 | |||
| 142 | |||
| 143 | Valid values are: C<"NODE">, C<"LEAF_NODE">, C<"POLICY">, C<"INDEX"> | ||
| 144 | |||
| 145 | =head2 B<REQUIRED> SchemaArn => Str | ||
| 146 | |||
| 147 | The schema ARN in which the new Facet will be created. For more | ||
| 148 | information, see arns. | ||
| 149 | |||
| 150 | |||
| 151 | |||
| 152 | |||
| 153 | =head1 SEE ALSO | ||
| 154 | |||
| 155 | This class forms part of L<Paws>, documenting arguments for method CreateFacet in L<Paws::CloudDirectory> | ||
| 156 | |||
| 157 | =head1 BUGS and CONTRIBUTIONS | ||
| 158 | |||
| 159 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 160 | |||
| 161 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 162 | |||
| 163 | =cut | ||
| 164 |