aws-sdk-observabilityadmin 1.12.0 → 1.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -36,6 +36,152 @@ module Aws::ObservabilityAdmin
36
36
  include Aws::Structure
37
37
  end
38
38
 
39
+ # Defines how telemetry data should be centralized across an Amazon Web
40
+ # Services Organization, including source and destination
41
+ # configurations.
42
+ #
43
+ # @!attribute [rw] source
44
+ # Configuration determining the source of the telemetry data to be
45
+ # centralized.
46
+ # @return [Types::CentralizationRuleSource]
47
+ #
48
+ # @!attribute [rw] destination
49
+ # Configuration determining where the telemetry data should be
50
+ # centralized, backed up, as well as encryption configuration for the
51
+ # primary and backup destinations.
52
+ # @return [Types::CentralizationRuleDestination]
53
+ #
54
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/CentralizationRule AWS API Documentation
55
+ #
56
+ class CentralizationRule < Struct.new(
57
+ :source,
58
+ :destination)
59
+ SENSITIVE = []
60
+ include Aws::Structure
61
+ end
62
+
63
+ # Configuration specifying the primary destination for centralized
64
+ # telemetry data.
65
+ #
66
+ # @!attribute [rw] region
67
+ # The primary destination region to which telemetry data should be
68
+ # centralized.
69
+ # @return [String]
70
+ #
71
+ # @!attribute [rw] account
72
+ # The destination account (within the organization) to which the
73
+ # telemetry data should be centralized.
74
+ # @return [String]
75
+ #
76
+ # @!attribute [rw] destination_logs_configuration
77
+ # Log specific configuration for centralization destination log
78
+ # groups.
79
+ # @return [Types::DestinationLogsConfiguration]
80
+ #
81
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/CentralizationRuleDestination AWS API Documentation
82
+ #
83
+ class CentralizationRuleDestination < Struct.new(
84
+ :region,
85
+ :account,
86
+ :destination_logs_configuration)
87
+ SENSITIVE = []
88
+ include Aws::Structure
89
+ end
90
+
91
+ # Configuration specifying the source of telemetry data to be
92
+ # centralized.
93
+ #
94
+ # @!attribute [rw] regions
95
+ # The list of source regions from which telemetry data should be
96
+ # centralized.
97
+ # @return [Array<String>]
98
+ #
99
+ # @!attribute [rw] scope
100
+ # The organizational scope from which telemetry data should be
101
+ # centralized, specified using organization id, accounts or
102
+ # organizational unit ids.
103
+ # @return [String]
104
+ #
105
+ # @!attribute [rw] source_logs_configuration
106
+ # Log specific configuration for centralization source log groups.
107
+ # @return [Types::SourceLogsConfiguration]
108
+ #
109
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/CentralizationRuleSource AWS API Documentation
110
+ #
111
+ class CentralizationRuleSource < Struct.new(
112
+ :regions,
113
+ :scope,
114
+ :source_logs_configuration)
115
+ SENSITIVE = []
116
+ include Aws::Structure
117
+ end
118
+
119
+ # A summary of a centralization rule's key properties and status.
120
+ #
121
+ # @!attribute [rw] rule_name
122
+ # The name of the organization centralization rule.
123
+ # @return [String]
124
+ #
125
+ # @!attribute [rw] rule_arn
126
+ # The Amazon Resource Name (ARN) of the organization centralization
127
+ # rule.
128
+ # @return [String]
129
+ #
130
+ # @!attribute [rw] creator_account_id
131
+ # The Amazon Web Services Account that created the organization
132
+ # centralization rule.
133
+ # @return [String]
134
+ #
135
+ # @!attribute [rw] created_time_stamp
136
+ # The timestamp when the organization centralization rule was created.
137
+ # @return [Integer]
138
+ #
139
+ # @!attribute [rw] created_region
140
+ # The Amazon Web Services region where the organization centralization
141
+ # rule was created.
142
+ # @return [String]
143
+ #
144
+ # @!attribute [rw] last_update_time_stamp
145
+ # The timestamp when the organization centralization rule was last
146
+ # updated.
147
+ # @return [Integer]
148
+ #
149
+ # @!attribute [rw] rule_health
150
+ # The health status of the organization centralization rule.
151
+ # @return [String]
152
+ #
153
+ # @!attribute [rw] failure_reason
154
+ # The reason why an organization centralization rule is marked
155
+ # UNHEALTHY.
156
+ # @return [String]
157
+ #
158
+ # @!attribute [rw] destination_account_id
159
+ # The primary destination account of the organization centralization
160
+ # rule.
161
+ # @return [String]
162
+ #
163
+ # @!attribute [rw] destination_region
164
+ # The primary destination region of the organization centralization
165
+ # rule.
166
+ # @return [String]
167
+ #
168
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/CentralizationRuleSummary AWS API Documentation
169
+ #
170
+ class CentralizationRuleSummary < Struct.new(
171
+ :rule_name,
172
+ :rule_arn,
173
+ :creator_account_id,
174
+ :created_time_stamp,
175
+ :created_region,
176
+ :last_update_time_stamp,
177
+ :rule_health,
178
+ :failure_reason,
179
+ :destination_account_id,
180
+ :destination_region)
181
+ SENSITIVE = []
182
+ include Aws::Structure
183
+ end
184
+
39
185
  # The requested operation conflicts with the current state of the
40
186
  # specified resource or with another request.
41
187
  #
@@ -50,6 +196,45 @@ module Aws::ObservabilityAdmin
50
196
  include Aws::Structure
51
197
  end
52
198
 
199
+ # @!attribute [rw] rule_name
200
+ # A unique name for the organization-wide centralization rule being
201
+ # created.
202
+ # @return [String]
203
+ #
204
+ # @!attribute [rw] rule
205
+ # The configuration details for the organization-wide centralization
206
+ # rule, including the source configuration and the destination
207
+ # configuration to centralize telemetry data across the organization.
208
+ # @return [Types::CentralizationRule]
209
+ #
210
+ # @!attribute [rw] tags
211
+ # The key-value pairs to associate with the organization telemetry
212
+ # rule resource for categorization and management purposes.
213
+ # @return [Hash<String,String>]
214
+ #
215
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/CreateCentralizationRuleForOrganizationInput AWS API Documentation
216
+ #
217
+ class CreateCentralizationRuleForOrganizationInput < Struct.new(
218
+ :rule_name,
219
+ :rule,
220
+ :tags)
221
+ SENSITIVE = []
222
+ include Aws::Structure
223
+ end
224
+
225
+ # @!attribute [rw] rule_arn
226
+ # The Amazon Resource Name (ARN) of the created organization
227
+ # centralization rule.
228
+ # @return [String]
229
+ #
230
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/CreateCentralizationRuleForOrganizationOutput AWS API Documentation
231
+ #
232
+ class CreateCentralizationRuleForOrganizationOutput < Struct.new(
233
+ :rule_arn)
234
+ SENSITIVE = []
235
+ include Aws::Structure
236
+ end
237
+
53
238
  # @!attribute [rw] rule_name
54
239
  # A unique name for the organization-wide telemetry rule being
55
240
  # created.
@@ -127,6 +312,19 @@ module Aws::ObservabilityAdmin
127
312
  include Aws::Structure
128
313
  end
129
314
 
315
+ # @!attribute [rw] rule_identifier
316
+ # The identifier (name or ARN) of the organization centralization rule
317
+ # to delete.
318
+ # @return [String]
319
+ #
320
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/DeleteCentralizationRuleForOrganizationInput AWS API Documentation
321
+ #
322
+ class DeleteCentralizationRuleForOrganizationInput < Struct.new(
323
+ :rule_identifier)
324
+ SENSITIVE = []
325
+ include Aws::Structure
326
+ end
327
+
130
328
  # @!attribute [rw] rule_identifier
131
329
  # The identifier (name or ARN) of the organization telemetry rule to
132
330
  # delete.
@@ -152,6 +350,118 @@ module Aws::ObservabilityAdmin
152
350
  include Aws::Structure
153
351
  end
154
352
 
353
+ # Configuration for centralization destination log groups, including
354
+ # encryption and backup settings.
355
+ #
356
+ # @!attribute [rw] logs_encryption_configuration
357
+ # The encryption configuration for centralization destination log
358
+ # groups.
359
+ # @return [Types::LogsEncryptionConfiguration]
360
+ #
361
+ # @!attribute [rw] backup_configuration
362
+ # Configuration defining the backup region and an optional KMS key for
363
+ # the backup destination.
364
+ # @return [Types::LogsBackupConfiguration]
365
+ #
366
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/DestinationLogsConfiguration AWS API Documentation
367
+ #
368
+ class DestinationLogsConfiguration < Struct.new(
369
+ :logs_encryption_configuration,
370
+ :backup_configuration)
371
+ SENSITIVE = []
372
+ include Aws::Structure
373
+ end
374
+
375
+ # @!attribute [rw] rule_identifier
376
+ # The identifier (name or ARN) of the organization centralization rule
377
+ # to retrieve.
378
+ # @return [String]
379
+ #
380
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/GetCentralizationRuleForOrganizationInput AWS API Documentation
381
+ #
382
+ class GetCentralizationRuleForOrganizationInput < Struct.new(
383
+ :rule_identifier)
384
+ SENSITIVE = []
385
+ include Aws::Structure
386
+ end
387
+
388
+ # @!attribute [rw] rule_name
389
+ # The name of the organization centralization rule.
390
+ # @return [String]
391
+ #
392
+ # @!attribute [rw] rule_arn
393
+ # The Amazon Resource Name (ARN) of the organization centralization
394
+ # rule.
395
+ # @return [String]
396
+ #
397
+ # @!attribute [rw] creator_account_id
398
+ # The Amazon Web Services Account that created the organization
399
+ # centralization rule.
400
+ # @return [String]
401
+ #
402
+ # @!attribute [rw] created_time_stamp
403
+ # The timestamp when the organization centralization rule was created.
404
+ # @return [Integer]
405
+ #
406
+ # @!attribute [rw] created_region
407
+ # The Amazon Web Services region where the organization centralization
408
+ # rule was created.
409
+ # @return [String]
410
+ #
411
+ # @!attribute [rw] last_update_time_stamp
412
+ # The timestamp when the organization centralization rule was last
413
+ # updated.
414
+ # @return [Integer]
415
+ #
416
+ # @!attribute [rw] rule_health
417
+ # The health status of the organization centralization rule.
418
+ # @return [String]
419
+ #
420
+ # @!attribute [rw] failure_reason
421
+ # The reason why an organization centralization rule is marked
422
+ # UNHEALTHY.
423
+ # @return [String]
424
+ #
425
+ # @!attribute [rw] centralization_rule
426
+ # The configuration details for the organization centralization rule.
427
+ # @return [Types::CentralizationRule]
428
+ #
429
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/GetCentralizationRuleForOrganizationOutput AWS API Documentation
430
+ #
431
+ class GetCentralizationRuleForOrganizationOutput < Struct.new(
432
+ :rule_name,
433
+ :rule_arn,
434
+ :creator_account_id,
435
+ :created_time_stamp,
436
+ :created_region,
437
+ :last_update_time_stamp,
438
+ :rule_health,
439
+ :failure_reason,
440
+ :centralization_rule)
441
+ SENSITIVE = []
442
+ include Aws::Structure
443
+ end
444
+
445
+ # @!attribute [rw] status
446
+ # The current status of the resource tags for telemetry feature
447
+ # (`Running`, `Stopped`, or `Impaired`).
448
+ # @return [String]
449
+ #
450
+ # @!attribute [rw] aws_resource_explorer_managed_view_arn
451
+ # The Amazon Resource Name (ARN) of the Amazon Web Services Resource
452
+ # Explorer managed view used for resource tags for telemetry, if the
453
+ # feature is enabled.
454
+ # @return [String]
455
+ #
456
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/GetTelemetryEnrichmentStatusOutput AWS API Documentation
457
+ #
458
+ class GetTelemetryEnrichmentStatusOutput < Struct.new(
459
+ :status,
460
+ :aws_resource_explorer_managed_view_arn)
461
+ SENSITIVE = []
462
+ include Aws::Structure
463
+ end
464
+
155
465
  # @!attribute [rw] status
156
466
  # The onboarding status of the telemetry config feature for the
157
467
  # organization.
@@ -298,6 +608,54 @@ module Aws::ObservabilityAdmin
298
608
  include Aws::Structure
299
609
  end
300
610
 
611
+ # @!attribute [rw] rule_name_prefix
612
+ # A string to filter organization centralization rules whose names
613
+ # begin with the specified prefix.
614
+ # @return [String]
615
+ #
616
+ # @!attribute [rw] all_regions
617
+ # A flag determining whether to return organization centralization
618
+ # rules from all regions or only the current region.
619
+ # @return [Boolean]
620
+ #
621
+ # @!attribute [rw] max_results
622
+ # The maximum number of organization centralization rules to return in
623
+ # a single call.
624
+ # @return [Integer]
625
+ #
626
+ # @!attribute [rw] next_token
627
+ # The token for the next set of results. A previous call generates
628
+ # this token.
629
+ # @return [String]
630
+ #
631
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/ListCentralizationRulesForOrganizationInput AWS API Documentation
632
+ #
633
+ class ListCentralizationRulesForOrganizationInput < Struct.new(
634
+ :rule_name_prefix,
635
+ :all_regions,
636
+ :max_results,
637
+ :next_token)
638
+ SENSITIVE = []
639
+ include Aws::Structure
640
+ end
641
+
642
+ # @!attribute [rw] centralization_rule_summaries
643
+ # A list of centralization rule summaries.
644
+ # @return [Array<Types::CentralizationRuleSummary>]
645
+ #
646
+ # @!attribute [rw] next_token
647
+ # A token to resume pagination of results.
648
+ # @return [String]
649
+ #
650
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/ListCentralizationRulesForOrganizationOutput AWS API Documentation
651
+ #
652
+ class ListCentralizationRulesForOrganizationOutput < Struct.new(
653
+ :centralization_rule_summaries,
654
+ :next_token)
655
+ SENSITIVE = []
656
+ include Aws::Structure
657
+ end
658
+
301
659
  # @!attribute [rw] account_identifiers
302
660
  # A list of Amazon Web Services accounts used to filter the resources
303
661
  # to those associated with the specified accounts.
@@ -562,6 +920,64 @@ module Aws::ObservabilityAdmin
562
920
  include Aws::Structure
563
921
  end
564
922
 
923
+ # Configuration for backing up centralized log data to a secondary
924
+ # region.
925
+ #
926
+ # @!attribute [rw] region
927
+ # Logs specific backup destination region within the primary
928
+ # destination account to which log data should be centralized.
929
+ # @return [String]
930
+ #
931
+ # @!attribute [rw] kms_key_arn
932
+ # KMS Key arn belonging to the primary destination account and backup
933
+ # region, to encrypt newly created central log groups in the backup
934
+ # destination.
935
+ # @return [String]
936
+ #
937
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/LogsBackupConfiguration AWS API Documentation
938
+ #
939
+ class LogsBackupConfiguration < Struct.new(
940
+ :region,
941
+ :kms_key_arn)
942
+ SENSITIVE = []
943
+ include Aws::Structure
944
+ end
945
+
946
+ # Configuration for encrypting centralized log groups. This
947
+ # configuration is only applied to destination log groups for which the
948
+ # corresponding source log groups are encrypted using Customer Managed
949
+ # KMS Keys.
950
+ #
951
+ # @!attribute [rw] encryption_strategy
952
+ # Configuration that determines the encryption strategy of the
953
+ # destination log groups. CUSTOMER\_MANAGED uses the configured
954
+ # KmsKeyArn to encrypt newly created destination log groups.
955
+ # @return [String]
956
+ #
957
+ # @!attribute [rw] kms_key_arn
958
+ # KMS Key arn belonging to the primary destination account and region,
959
+ # to encrypt newly created central log groups in the primary
960
+ # destination.
961
+ # @return [String]
962
+ #
963
+ # @!attribute [rw] encryption_conflict_resolution_strategy
964
+ # Conflict resolution strategy for centralization if the encryption
965
+ # strategy is set to CUSTOMER\_MANAGED and the destination log group
966
+ # is encrypted with an AWS\_OWNED KMS Key. ALLOW lets centralization
967
+ # go through while SKIP prevents centralization into the destination
968
+ # log group.
969
+ # @return [String]
970
+ #
971
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/LogsEncryptionConfiguration AWS API Documentation
972
+ #
973
+ class LogsEncryptionConfiguration < Struct.new(
974
+ :encryption_strategy,
975
+ :kms_key_arn,
976
+ :encryption_conflict_resolution_strategy)
977
+ SENSITIVE = []
978
+ include Aws::Structure
979
+ end
980
+
565
981
  # The specified resource (such as a telemetry rule) could not be found.
566
982
  #
567
983
  # @!attribute [rw] message
@@ -594,6 +1010,63 @@ module Aws::ObservabilityAdmin
594
1010
  include Aws::Structure
595
1011
  end
596
1012
 
1013
+ # Configuration for selecting and handling source log groups for
1014
+ # centralization.
1015
+ #
1016
+ # @!attribute [rw] log_group_selection_criteria
1017
+ # The selection criteria that specifies which source log groups to
1018
+ # centralize. The selection criteria uses the same format as OAM link
1019
+ # filters.
1020
+ # @return [String]
1021
+ #
1022
+ # @!attribute [rw] encrypted_log_group_strategy
1023
+ # A strategy determining whether to centralize source log groups that
1024
+ # are encrypted with customer managed KMS keys (CMK). ALLOW will
1025
+ # consider CMK encrypted source log groups for centralization while
1026
+ # SKIP will skip CMK encrypted source log groups from centralization.
1027
+ # @return [String]
1028
+ #
1029
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/SourceLogsConfiguration AWS API Documentation
1030
+ #
1031
+ class SourceLogsConfiguration < Struct.new(
1032
+ :log_group_selection_criteria,
1033
+ :encrypted_log_group_strategy)
1034
+ SENSITIVE = []
1035
+ include Aws::Structure
1036
+ end
1037
+
1038
+ # @!attribute [rw] status
1039
+ # The status of the resource tags for telemetry feature after the
1040
+ # start operation (`Running`, `Stopped`, or `Impaired`).
1041
+ # @return [String]
1042
+ #
1043
+ # @!attribute [rw] aws_resource_explorer_managed_view_arn
1044
+ # The Amazon Resource Name (ARN) of the Amazon Web Services Resource
1045
+ # Explorer managed view created for resource tags for telemetry.
1046
+ # @return [String]
1047
+ #
1048
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/StartTelemetryEnrichmentOutput AWS API Documentation
1049
+ #
1050
+ class StartTelemetryEnrichmentOutput < Struct.new(
1051
+ :status,
1052
+ :aws_resource_explorer_managed_view_arn)
1053
+ SENSITIVE = []
1054
+ include Aws::Structure
1055
+ end
1056
+
1057
+ # @!attribute [rw] status
1058
+ # The status of the resource tags for telemetry feature after the stop
1059
+ # operation (`Running`, `Stopped`, or `Impaired`).
1060
+ # @return [String]
1061
+ #
1062
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/StopTelemetryEnrichmentOutput AWS API Documentation
1063
+ #
1064
+ class StopTelemetryEnrichmentOutput < Struct.new(
1065
+ :status)
1066
+ SENSITIVE = []
1067
+ include Aws::Structure
1068
+ end
1069
+
597
1070
  # @!attribute [rw] resource_arn
598
1071
  # The Amazon Resource Name (ARN) of the telemetry rule resource to
599
1072
  # tag.
@@ -801,6 +1274,39 @@ module Aws::ObservabilityAdmin
801
1274
  include Aws::Structure
802
1275
  end
803
1276
 
1277
+ # @!attribute [rw] rule_identifier
1278
+ # The identifier (name or ARN) of the organization centralization rule
1279
+ # to update.
1280
+ # @return [String]
1281
+ #
1282
+ # @!attribute [rw] rule
1283
+ # The configuration details for the organization-wide centralization
1284
+ # rule, including the source configuration and the destination
1285
+ # configuration to centralize telemetry data across the organization.
1286
+ # @return [Types::CentralizationRule]
1287
+ #
1288
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/UpdateCentralizationRuleForOrganizationInput AWS API Documentation
1289
+ #
1290
+ class UpdateCentralizationRuleForOrganizationInput < Struct.new(
1291
+ :rule_identifier,
1292
+ :rule)
1293
+ SENSITIVE = []
1294
+ include Aws::Structure
1295
+ end
1296
+
1297
+ # @!attribute [rw] rule_arn
1298
+ # The Amazon Resource Name (ARN) of the updated organization
1299
+ # centralization rule.
1300
+ # @return [String]
1301
+ #
1302
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/UpdateCentralizationRuleForOrganizationOutput AWS API Documentation
1303
+ #
1304
+ class UpdateCentralizationRuleForOrganizationOutput < Struct.new(
1305
+ :rule_arn)
1306
+ SENSITIVE = []
1307
+ include Aws::Structure
1308
+ end
1309
+
804
1310
  # @!attribute [rw] rule_identifier
805
1311
  # The identifier (name or ARN) of the organization telemetry rule to
806
1312
  # update.
@@ -23,7 +23,7 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:observabilityadmin)
23
23
  # structure.
24
24
  #
25
25
  # observability_admin = Aws::ObservabilityAdmin::Client.new
26
- # resp = observability_admin.create_telemetry_rule(params)
26
+ # resp = observability_admin.create_centralization_rule_for_organization(params)
27
27
  #
28
28
  # See {Client} for more information.
29
29
  #
@@ -55,7 +55,7 @@ module Aws::ObservabilityAdmin
55
55
  autoload :EndpointProvider, 'aws-sdk-observabilityadmin/endpoint_provider'
56
56
  autoload :Endpoints, 'aws-sdk-observabilityadmin/endpoints'
57
57
 
58
- GEM_VERSION = '1.12.0'
58
+ GEM_VERSION = '1.14.0'
59
59
 
60
60
  end
61
61