aws-sdk-managedgrafana 1.9.0 → 1.11.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +12 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-managedgrafana/client.rb +164 -33
- data/lib/aws-sdk-managedgrafana/client_api.rb +61 -0
- data/lib/aws-sdk-managedgrafana/endpoint_provider.rb +35 -95
- data/lib/aws-sdk-managedgrafana/endpoints.rb +28 -0
- data/lib/aws-sdk-managedgrafana/plugins/endpoints.rb +4 -0
- data/lib/aws-sdk-managedgrafana/types.rb +155 -287
- data/lib/aws-sdk-managedgrafana.rb +1 -1
- metadata +2 -2
@@ -27,18 +27,6 @@ module Aws::ManagedGrafana
|
|
27
27
|
# be used to define information about the users authenticated by the IdP
|
28
28
|
# to use the workspace.
|
29
29
|
#
|
30
|
-
# @note When making an API call, you may pass AssertionAttributes
|
31
|
-
# data as a hash:
|
32
|
-
#
|
33
|
-
# {
|
34
|
-
# email: "AssertionAttribute",
|
35
|
-
# groups: "AssertionAttribute",
|
36
|
-
# login: "AssertionAttribute",
|
37
|
-
# name: "AssertionAttribute",
|
38
|
-
# org: "AssertionAttribute",
|
39
|
-
# role: "AssertionAttribute",
|
40
|
-
# }
|
41
|
-
#
|
42
30
|
# @!attribute [rw] email
|
43
31
|
# The name of the attribute within the SAML assertion to use as the
|
44
32
|
# email names for SAML users.
|
@@ -82,14 +70,6 @@ module Aws::ManagedGrafana
|
|
82
70
|
include Aws::Structure
|
83
71
|
end
|
84
72
|
|
85
|
-
# @note When making an API call, you may pass AssociateLicenseRequest
|
86
|
-
# data as a hash:
|
87
|
-
#
|
88
|
-
# {
|
89
|
-
# license_type: "ENTERPRISE", # required, accepts ENTERPRISE, ENTERPRISE_FREE_TRIAL
|
90
|
-
# workspace_id: "WorkspaceId", # required
|
91
|
-
# }
|
92
|
-
#
|
93
73
|
# @!attribute [rw] license_type
|
94
74
|
# The type of license to associate with the workspace.
|
95
75
|
# @return [String]
|
@@ -124,13 +104,13 @@ module Aws::ManagedGrafana
|
|
124
104
|
#
|
125
105
|
# @!attribute [rw] aws_sso
|
126
106
|
# A structure containing information about how this workspace works
|
127
|
-
# with
|
107
|
+
# with IAM Identity Center.
|
128
108
|
# @return [Types::AwsSsoAuthentication]
|
129
109
|
#
|
130
110
|
# @!attribute [rw] providers
|
131
|
-
# Specifies whether this workspace uses
|
132
|
-
#
|
133
|
-
#
|
111
|
+
# Specifies whether this workspace uses IAM Identity Center, SAML, or
|
112
|
+
# both methods to authenticate users to use the Grafana console in the
|
113
|
+
# Amazon Managed Grafana workspace.
|
134
114
|
# @return [Array<String>]
|
135
115
|
#
|
136
116
|
# @!attribute [rw] saml
|
@@ -149,13 +129,13 @@ module Aws::ManagedGrafana
|
|
149
129
|
include Aws::Structure
|
150
130
|
end
|
151
131
|
|
152
|
-
# A structure that describes whether the workspace uses SAML,
|
153
|
-
#
|
132
|
+
# A structure that describes whether the workspace uses SAML, IAM
|
133
|
+
# Identity Center, or both methods for user authentication, and whether
|
154
134
|
# that authentication is fully configured.
|
155
135
|
#
|
156
136
|
# @!attribute [rw] providers
|
157
|
-
# Specifies whether the workspace uses SAML,
|
158
|
-
#
|
137
|
+
# Specifies whether the workspace uses SAML, IAM Identity Center, or
|
138
|
+
# both methods for user authentication.
|
159
139
|
# @return [Array<String>]
|
160
140
|
#
|
161
141
|
# @!attribute [rw] saml_configuration_status
|
@@ -173,10 +153,10 @@ module Aws::ManagedGrafana
|
|
173
153
|
end
|
174
154
|
|
175
155
|
# A structure containing information about how this workspace works with
|
176
|
-
#
|
156
|
+
# IAM Identity Center.
|
177
157
|
#
|
178
158
|
# @!attribute [rw] sso_client_id
|
179
|
-
# The ID of the
|
159
|
+
# The ID of the IAM Identity Center-managed application that is
|
180
160
|
# created by Amazon Managed Grafana.
|
181
161
|
# @return [String]
|
182
162
|
#
|
@@ -213,25 +193,15 @@ module Aws::ManagedGrafana
|
|
213
193
|
include Aws::Structure
|
214
194
|
end
|
215
195
|
|
216
|
-
# @note When making an API call, you may pass CreateWorkspaceApiKeyRequest
|
217
|
-
# data as a hash:
|
218
|
-
#
|
219
|
-
# {
|
220
|
-
# key_name: "ApiKeyName", # required
|
221
|
-
# key_role: "String", # required
|
222
|
-
# seconds_to_live: 1, # required
|
223
|
-
# workspace_id: "WorkspaceId", # required
|
224
|
-
# }
|
225
|
-
#
|
226
196
|
# @!attribute [rw] key_name
|
227
|
-
# Specifies the name of the key
|
228
|
-
#
|
197
|
+
# Specifies the name of the key. Keynames must be unique to the
|
198
|
+
# workspace.
|
229
199
|
# @return [String]
|
230
200
|
#
|
231
201
|
# @!attribute [rw] key_role
|
232
202
|
# Specifies the permission level of the key.
|
233
203
|
#
|
234
|
-
# Valid
|
204
|
+
# Valid values: `VIEWER`\|`EDITOR`\|`ADMIN`
|
235
205
|
# @return [String]
|
236
206
|
#
|
237
207
|
# @!attribute [rw] seconds_to_live
|
@@ -240,7 +210,7 @@ module Aws::ManagedGrafana
|
|
240
210
|
# @return [Integer]
|
241
211
|
#
|
242
212
|
# @!attribute [rw] workspace_id
|
243
|
-
# The ID of the workspace
|
213
|
+
# The ID of the workspace to create an API key.
|
244
214
|
# @return [String]
|
245
215
|
#
|
246
216
|
# @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/CreateWorkspaceApiKeyRequest AWS API Documentation
|
@@ -255,8 +225,8 @@ module Aws::ManagedGrafana
|
|
255
225
|
end
|
256
226
|
|
257
227
|
# @!attribute [rw] key
|
258
|
-
# The key token
|
259
|
-
#
|
228
|
+
# The key token. Use this value as a bearer token to authenticate HTTP
|
229
|
+
# requests to the workspace.
|
260
230
|
# @return [String]
|
261
231
|
#
|
262
232
|
# @!attribute [rw] key_name
|
@@ -277,27 +247,6 @@ module Aws::ManagedGrafana
|
|
277
247
|
include Aws::Structure
|
278
248
|
end
|
279
249
|
|
280
|
-
# @note When making an API call, you may pass CreateWorkspaceRequest
|
281
|
-
# data as a hash:
|
282
|
-
#
|
283
|
-
# {
|
284
|
-
# account_access_type: "CURRENT_ACCOUNT", # required, accepts CURRENT_ACCOUNT, ORGANIZATION
|
285
|
-
# authentication_providers: ["AWS_SSO"], # required, accepts AWS_SSO, SAML
|
286
|
-
# client_token: "ClientToken",
|
287
|
-
# organization_role_name: "OrganizationRoleName",
|
288
|
-
# permission_type: "CUSTOMER_MANAGED", # required, accepts CUSTOMER_MANAGED, SERVICE_MANAGED
|
289
|
-
# stack_set_name: "StackSetName",
|
290
|
-
# tags: {
|
291
|
-
# "TagKey" => "TagValue",
|
292
|
-
# },
|
293
|
-
# workspace_data_sources: ["AMAZON_OPENSEARCH_SERVICE"], # accepts AMAZON_OPENSEARCH_SERVICE, CLOUDWATCH, PROMETHEUS, XRAY, TIMESTREAM, SITEWISE, ATHENA, REDSHIFT
|
294
|
-
# workspace_description: "Description",
|
295
|
-
# workspace_name: "WorkspaceName",
|
296
|
-
# workspace_notification_destinations: ["SNS"], # accepts SNS
|
297
|
-
# workspace_organizational_units: ["OrganizationalUnit"],
|
298
|
-
# workspace_role_arn: "IamRoleArn",
|
299
|
-
# }
|
300
|
-
#
|
301
250
|
# @!attribute [rw] account_access_type
|
302
251
|
# Specifies whether the workspace can access Amazon Web Services
|
303
252
|
# resources in this Amazon Web Services account only, or whether it
|
@@ -308,10 +257,10 @@ module Aws::ManagedGrafana
|
|
308
257
|
# @return [String]
|
309
258
|
#
|
310
259
|
# @!attribute [rw] authentication_providers
|
311
|
-
# Specifies whether this workspace uses SAML 2.0,
|
312
|
-
# Single Sign
|
313
|
-
# console within a workspace. For more information,
|
314
|
-
# authentication in Amazon Managed Grafana][1].
|
260
|
+
# Specifies whether this workspace uses SAML 2.0, IAM Identity Center
|
261
|
+
# (successor to Single Sign-On), or both to authenticate users for
|
262
|
+
# using the Grafana console within a workspace. For more information,
|
263
|
+
# see [User authentication in Amazon Managed Grafana][1].
|
315
264
|
#
|
316
265
|
#
|
317
266
|
#
|
@@ -326,6 +275,16 @@ module Aws::ManagedGrafana
|
|
326
275
|
# not need to pass this option.
|
327
276
|
# @return [String]
|
328
277
|
#
|
278
|
+
# @!attribute [rw] configuration
|
279
|
+
# The configuration string for the workspace that you create. For more
|
280
|
+
# information about the format and configuration options available,
|
281
|
+
# see [Working in your Grafana workspace][1].
|
282
|
+
#
|
283
|
+
#
|
284
|
+
#
|
285
|
+
# [1]: https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html
|
286
|
+
# @return [String]
|
287
|
+
#
|
329
288
|
# @!attribute [rw] organization_role_name
|
330
289
|
# The name of an IAM role that already exists to use with
|
331
290
|
# Organizations to access Amazon Web Services data sources and
|
@@ -336,9 +295,12 @@ module Aws::ManagedGrafana
|
|
336
295
|
# If you specify `SERVICE_MANAGED` on AWS Grafana console, Amazon
|
337
296
|
# Managed Grafana automatically creates the IAM roles and provisions
|
338
297
|
# the permissions that the workspace needs to use Amazon Web Services
|
339
|
-
# data sources and notification channels. In CLI mode, the
|
298
|
+
# data sources and notification channels. In the CLI mode, the
|
340
299
|
# permissionType `SERVICE_MANAGED` will not create the IAM role for
|
341
|
-
# you.
|
300
|
+
# you. The ability for the Amazon Managed Grafana to create the IAM
|
301
|
+
# role on behalf of the user is supported only in the Amazon Managed
|
302
|
+
# Grafana AWS console. Use only the `CUSTOMER_MANAGED` permission type
|
303
|
+
# when creating a workspace in the CLI.
|
342
304
|
#
|
343
305
|
# If you specify `CUSTOMER_MANAGED`, you will manage those roles and
|
344
306
|
# permissions yourself. If you are creating this workspace in a member
|
@@ -365,6 +327,11 @@ module Aws::ManagedGrafana
|
|
365
327
|
# The list of tags associated with the workspace.
|
366
328
|
# @return [Hash<String,String>]
|
367
329
|
#
|
330
|
+
# @!attribute [rw] vpc_configuration
|
331
|
+
# The configuration settings for an Amazon VPC that contains data
|
332
|
+
# sources for your Grafana workspace to connect to.
|
333
|
+
# @return [Types::VpcConfiguration]
|
334
|
+
#
|
368
335
|
# @!attribute [rw] workspace_data_sources
|
369
336
|
# Specify the Amazon Web Services data sources that you want to be
|
370
337
|
# queried in this workspace. Specifying these data sources here
|
@@ -415,10 +382,12 @@ module Aws::ManagedGrafana
|
|
415
382
|
:account_access_type,
|
416
383
|
:authentication_providers,
|
417
384
|
:client_token,
|
385
|
+
:configuration,
|
418
386
|
:organization_role_name,
|
419
387
|
:permission_type,
|
420
388
|
:stack_set_name,
|
421
389
|
:tags,
|
390
|
+
:vpc_configuration,
|
422
391
|
:workspace_data_sources,
|
423
392
|
:workspace_description,
|
424
393
|
:workspace_name,
|
@@ -441,14 +410,6 @@ module Aws::ManagedGrafana
|
|
441
410
|
include Aws::Structure
|
442
411
|
end
|
443
412
|
|
444
|
-
# @note When making an API call, you may pass DeleteWorkspaceApiKeyRequest
|
445
|
-
# data as a hash:
|
446
|
-
#
|
447
|
-
# {
|
448
|
-
# key_name: "ApiKeyName", # required
|
449
|
-
# workspace_id: "WorkspaceId", # required
|
450
|
-
# }
|
451
|
-
#
|
452
413
|
# @!attribute [rw] key_name
|
453
414
|
# The name of the API key to delete.
|
454
415
|
# @return [String]
|
@@ -467,7 +428,7 @@ module Aws::ManagedGrafana
|
|
467
428
|
end
|
468
429
|
|
469
430
|
# @!attribute [rw] key_name
|
470
|
-
# The name of the
|
431
|
+
# The name of the key that was deleted.
|
471
432
|
# @return [String]
|
472
433
|
#
|
473
434
|
# @!attribute [rw] workspace_id
|
@@ -483,13 +444,6 @@ module Aws::ManagedGrafana
|
|
483
444
|
include Aws::Structure
|
484
445
|
end
|
485
446
|
|
486
|
-
# @note When making an API call, you may pass DeleteWorkspaceRequest
|
487
|
-
# data as a hash:
|
488
|
-
#
|
489
|
-
# {
|
490
|
-
# workspace_id: "WorkspaceId", # required
|
491
|
-
# }
|
492
|
-
#
|
493
447
|
# @!attribute [rw] workspace_id
|
494
448
|
# The ID of the workspace to delete.
|
495
449
|
# @return [String]
|
@@ -515,13 +469,6 @@ module Aws::ManagedGrafana
|
|
515
469
|
include Aws::Structure
|
516
470
|
end
|
517
471
|
|
518
|
-
# @note When making an API call, you may pass DescribeWorkspaceAuthenticationRequest
|
519
|
-
# data as a hash:
|
520
|
-
#
|
521
|
-
# {
|
522
|
-
# workspace_id: "WorkspaceId", # required
|
523
|
-
# }
|
524
|
-
#
|
525
472
|
# @!attribute [rw] workspace_id
|
526
473
|
# The ID of the workspace to return authentication information about.
|
527
474
|
# @return [String]
|
@@ -547,13 +494,36 @@ module Aws::ManagedGrafana
|
|
547
494
|
include Aws::Structure
|
548
495
|
end
|
549
496
|
|
550
|
-
#
|
551
|
-
#
|
497
|
+
# @!attribute [rw] workspace_id
|
498
|
+
# The ID of the workspace to get configuration information for.
|
499
|
+
# @return [String]
|
552
500
|
#
|
553
|
-
#
|
554
|
-
# workspace_id: "WorkspaceId", # required
|
555
|
-
# }
|
501
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/DescribeWorkspaceConfigurationRequest AWS API Documentation
|
556
502
|
#
|
503
|
+
class DescribeWorkspaceConfigurationRequest < Struct.new(
|
504
|
+
:workspace_id)
|
505
|
+
SENSITIVE = []
|
506
|
+
include Aws::Structure
|
507
|
+
end
|
508
|
+
|
509
|
+
# @!attribute [rw] configuration
|
510
|
+
# The configuration string for the workspace that you requested. For
|
511
|
+
# more information about the format and configuration options
|
512
|
+
# available, see [Working in your Grafana workspace][1].
|
513
|
+
#
|
514
|
+
#
|
515
|
+
#
|
516
|
+
# [1]: https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html
|
517
|
+
# @return [String]
|
518
|
+
#
|
519
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/DescribeWorkspaceConfigurationResponse AWS API Documentation
|
520
|
+
#
|
521
|
+
class DescribeWorkspaceConfigurationResponse < Struct.new(
|
522
|
+
:configuration)
|
523
|
+
SENSITIVE = []
|
524
|
+
include Aws::Structure
|
525
|
+
end
|
526
|
+
|
557
527
|
# @!attribute [rw] workspace_id
|
558
528
|
# The ID of the workspace to display information about.
|
559
529
|
# @return [String]
|
@@ -578,14 +548,6 @@ module Aws::ManagedGrafana
|
|
578
548
|
include Aws::Structure
|
579
549
|
end
|
580
550
|
|
581
|
-
# @note When making an API call, you may pass DisassociateLicenseRequest
|
582
|
-
# data as a hash:
|
583
|
-
#
|
584
|
-
# {
|
585
|
-
# license_type: "ENTERPRISE", # required, accepts ENTERPRISE, ENTERPRISE_FREE_TRIAL
|
586
|
-
# workspace_id: "WorkspaceId", # required
|
587
|
-
# }
|
588
|
-
#
|
589
551
|
# @!attribute [rw] license_type
|
590
552
|
# The type of license to remove from the workspace.
|
591
553
|
# @return [String]
|
@@ -620,18 +582,18 @@ module Aws::ManagedGrafana
|
|
620
582
|
# integrate the identity provider with this workspace. You can specify
|
621
583
|
# the metadata either by providing a URL to its location in the `url`
|
622
584
|
# parameter, or by specifying the full metadata in XML format in the
|
623
|
-
# `xml` parameter.
|
585
|
+
# `xml` parameter. Specifying both will cause an error.
|
624
586
|
#
|
625
587
|
# @note IdpMetadata is a union - when making an API calls you must set exactly one of the members.
|
626
588
|
#
|
627
589
|
# @note IdpMetadata is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of IdpMetadata corresponding to the set member.
|
628
590
|
#
|
629
591
|
# @!attribute [rw] url
|
630
|
-
# The URL of the location containing the metadata.
|
592
|
+
# The URL of the location containing the IdP metadata.
|
631
593
|
# @return [String]
|
632
594
|
#
|
633
595
|
# @!attribute [rw] xml
|
634
|
-
# The
|
596
|
+
# The full IdP metadata, in XML format.
|
635
597
|
# @return [String]
|
636
598
|
#
|
637
599
|
# @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/IdpMetadata AWS API Documentation
|
@@ -668,18 +630,6 @@ module Aws::ManagedGrafana
|
|
668
630
|
include Aws::Structure
|
669
631
|
end
|
670
632
|
|
671
|
-
# @note When making an API call, you may pass ListPermissionsRequest
|
672
|
-
# data as a hash:
|
673
|
-
#
|
674
|
-
# {
|
675
|
-
# group_id: "SsoId",
|
676
|
-
# max_results: 1,
|
677
|
-
# next_token: "PaginationToken",
|
678
|
-
# user_id: "SsoId",
|
679
|
-
# user_type: "SSO_USER", # accepts SSO_USER, SSO_GROUP
|
680
|
-
# workspace_id: "WorkspaceId", # required
|
681
|
-
# }
|
682
|
-
#
|
683
633
|
# @!attribute [rw] group_id
|
684
634
|
# (Optional) Limits the results to only the group that matches this
|
685
635
|
# ID.
|
@@ -700,9 +650,8 @@ module Aws::ManagedGrafana
|
|
700
650
|
#
|
701
651
|
# @!attribute [rw] user_type
|
702
652
|
# (Optional) If you specify `SSO_USER`, then only the permissions of
|
703
|
-
#
|
704
|
-
#
|
705
|
-
# are returned.
|
653
|
+
# IAM Identity Center users are returned. If you specify `SSO_GROUP`,
|
654
|
+
# only the permissions of IAM Identity Center groups are returned.
|
706
655
|
# @return [String]
|
707
656
|
#
|
708
657
|
# @!attribute [rw] workspace_id
|
@@ -741,13 +690,6 @@ module Aws::ManagedGrafana
|
|
741
690
|
include Aws::Structure
|
742
691
|
end
|
743
692
|
|
744
|
-
# @note When making an API call, you may pass ListTagsForResourceRequest
|
745
|
-
# data as a hash:
|
746
|
-
#
|
747
|
-
# {
|
748
|
-
# resource_arn: "String", # required
|
749
|
-
# }
|
750
|
-
#
|
751
693
|
# @!attribute [rw] resource_arn
|
752
694
|
# The ARN of the resource the list of tags are associated with.
|
753
695
|
# @return [String]
|
@@ -772,14 +714,6 @@ module Aws::ManagedGrafana
|
|
772
714
|
include Aws::Structure
|
773
715
|
end
|
774
716
|
|
775
|
-
# @note When making an API call, you may pass ListWorkspacesRequest
|
776
|
-
# data as a hash:
|
777
|
-
#
|
778
|
-
# {
|
779
|
-
# max_results: 1,
|
780
|
-
# next_token: "PaginationToken",
|
781
|
-
# }
|
782
|
-
#
|
783
717
|
# @!attribute [rw] max_results
|
784
718
|
# The maximum number of workspaces to include in the results.
|
785
719
|
# @return [Integer]
|
@@ -817,11 +751,11 @@ module Aws::ManagedGrafana
|
|
817
751
|
end
|
818
752
|
|
819
753
|
# A structure containing the identity of one user or group and the
|
820
|
-
# `Admin` or `
|
754
|
+
# `Admin`, `Editor`, or `Viewer` role that they have.
|
821
755
|
#
|
822
756
|
# @!attribute [rw] role
|
823
|
-
# Specifies whether the user or group has the `Admin` or
|
824
|
-
# role.
|
757
|
+
# Specifies whether the user or group has the `Admin`, `Editor`, or
|
758
|
+
# `Viewer` role.
|
825
759
|
# @return [String]
|
826
760
|
#
|
827
761
|
# @!attribute [rw] user
|
@@ -863,15 +797,8 @@ module Aws::ManagedGrafana
|
|
863
797
|
|
864
798
|
# This structure defines which groups defined in the SAML assertion
|
865
799
|
# attribute are to be mapped to the Grafana `Admin` and `Editor` roles
|
866
|
-
# in the workspace.
|
867
|
-
#
|
868
|
-
# @note When making an API call, you may pass RoleValues
|
869
|
-
# data as a hash:
|
870
|
-
#
|
871
|
-
# {
|
872
|
-
# admin: ["RoleValue"],
|
873
|
-
# editor: ["RoleValue"],
|
874
|
-
# }
|
800
|
+
# in the workspace. SAML authenticated users not part of `Admin` or
|
801
|
+
# `Editor` role groups have `Viewer` permission over the workspace.
|
875
802
|
#
|
876
803
|
# @!attribute [rw] admin
|
877
804
|
# A list of groups from the SAML assertion attribute to grant the
|
@@ -916,30 +843,6 @@ module Aws::ManagedGrafana
|
|
916
843
|
# A structure containing information about how this workspace works with
|
917
844
|
# SAML.
|
918
845
|
#
|
919
|
-
# @note When making an API call, you may pass SamlConfiguration
|
920
|
-
# data as a hash:
|
921
|
-
#
|
922
|
-
# {
|
923
|
-
# allowed_organizations: ["AllowedOrganization"],
|
924
|
-
# assertion_attributes: {
|
925
|
-
# email: "AssertionAttribute",
|
926
|
-
# groups: "AssertionAttribute",
|
927
|
-
# login: "AssertionAttribute",
|
928
|
-
# name: "AssertionAttribute",
|
929
|
-
# org: "AssertionAttribute",
|
930
|
-
# role: "AssertionAttribute",
|
931
|
-
# },
|
932
|
-
# idp_metadata: { # required
|
933
|
-
# url: "IdpMetadataUrl",
|
934
|
-
# xml: "String",
|
935
|
-
# },
|
936
|
-
# login_validity_duration: 1,
|
937
|
-
# role_values: {
|
938
|
-
# admin: ["RoleValue"],
|
939
|
-
# editor: ["RoleValue"],
|
940
|
-
# },
|
941
|
-
# }
|
942
|
-
#
|
943
846
|
# @!attribute [rw] allowed_organizations
|
944
847
|
# Lists which organizations defined in the SAML assertion are allowed
|
945
848
|
# to use the Amazon Managed Grafana workspace. If this is empty, all
|
@@ -1014,16 +917,6 @@ module Aws::ManagedGrafana
|
|
1014
917
|
include Aws::Structure
|
1015
918
|
end
|
1016
919
|
|
1017
|
-
# @note When making an API call, you may pass TagResourceRequest
|
1018
|
-
# data as a hash:
|
1019
|
-
#
|
1020
|
-
# {
|
1021
|
-
# resource_arn: "String", # required
|
1022
|
-
# tags: { # required
|
1023
|
-
# "TagKey" => "TagValue",
|
1024
|
-
# },
|
1025
|
-
# }
|
1026
|
-
#
|
1027
920
|
# @!attribute [rw] resource_arn
|
1028
921
|
# The ARN of the resource the tag is associated with.
|
1029
922
|
# @return [String]
|
@@ -1077,14 +970,6 @@ module Aws::ManagedGrafana
|
|
1077
970
|
include Aws::Structure
|
1078
971
|
end
|
1079
972
|
|
1080
|
-
# @note When making an API call, you may pass UntagResourceRequest
|
1081
|
-
# data as a hash:
|
1082
|
-
#
|
1083
|
-
# {
|
1084
|
-
# resource_arn: "String", # required
|
1085
|
-
# tag_keys: ["TagKey"], # required
|
1086
|
-
# }
|
1087
|
-
#
|
1088
973
|
# @!attribute [rw] resource_arn
|
1089
974
|
# The ARN of the resource the tag association is removed from.
|
1090
975
|
# @return [String]
|
@@ -1142,20 +1027,6 @@ module Aws::ManagedGrafana
|
|
1142
1027
|
#
|
1143
1028
|
# [1]: https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html
|
1144
1029
|
#
|
1145
|
-
# @note When making an API call, you may pass UpdateInstruction
|
1146
|
-
# data as a hash:
|
1147
|
-
#
|
1148
|
-
# {
|
1149
|
-
# action: "ADD", # required, accepts ADD, REVOKE
|
1150
|
-
# role: "ADMIN", # required, accepts ADMIN, EDITOR, VIEWER
|
1151
|
-
# users: [ # required
|
1152
|
-
# {
|
1153
|
-
# id: "SsoId", # required
|
1154
|
-
# type: "SSO_USER", # required, accepts SSO_USER, SSO_GROUP
|
1155
|
-
# },
|
1156
|
-
# ],
|
1157
|
-
# }
|
1158
|
-
#
|
1159
1030
|
# @!attribute [rw] action
|
1160
1031
|
# Specifies whether this update is to add or revoke role permissions.
|
1161
1032
|
# @return [String]
|
@@ -1180,25 +1051,6 @@ module Aws::ManagedGrafana
|
|
1180
1051
|
include Aws::Structure
|
1181
1052
|
end
|
1182
1053
|
|
1183
|
-
# @note When making an API call, you may pass UpdatePermissionsRequest
|
1184
|
-
# data as a hash:
|
1185
|
-
#
|
1186
|
-
# {
|
1187
|
-
# update_instruction_batch: [ # required
|
1188
|
-
# {
|
1189
|
-
# action: "ADD", # required, accepts ADD, REVOKE
|
1190
|
-
# role: "ADMIN", # required, accepts ADMIN, EDITOR, VIEWER
|
1191
|
-
# users: [ # required
|
1192
|
-
# {
|
1193
|
-
# id: "SsoId", # required
|
1194
|
-
# type: "SSO_USER", # required, accepts SSO_USER, SSO_GROUP
|
1195
|
-
# },
|
1196
|
-
# ],
|
1197
|
-
# },
|
1198
|
-
# ],
|
1199
|
-
# workspace_id: "WorkspaceId", # required
|
1200
|
-
# }
|
1201
|
-
#
|
1202
1054
|
# @!attribute [rw] update_instruction_batch
|
1203
1055
|
# An array of structures that contain the permission updates to make.
|
1204
1056
|
# @return [Array<Types::UpdateInstruction>]
|
@@ -1229,39 +1081,11 @@ module Aws::ManagedGrafana
|
|
1229
1081
|
include Aws::Structure
|
1230
1082
|
end
|
1231
1083
|
|
1232
|
-
# @note When making an API call, you may pass UpdateWorkspaceAuthenticationRequest
|
1233
|
-
# data as a hash:
|
1234
|
-
#
|
1235
|
-
# {
|
1236
|
-
# authentication_providers: ["AWS_SSO"], # required, accepts AWS_SSO, SAML
|
1237
|
-
# saml_configuration: {
|
1238
|
-
# allowed_organizations: ["AllowedOrganization"],
|
1239
|
-
# assertion_attributes: {
|
1240
|
-
# email: "AssertionAttribute",
|
1241
|
-
# groups: "AssertionAttribute",
|
1242
|
-
# login: "AssertionAttribute",
|
1243
|
-
# name: "AssertionAttribute",
|
1244
|
-
# org: "AssertionAttribute",
|
1245
|
-
# role: "AssertionAttribute",
|
1246
|
-
# },
|
1247
|
-
# idp_metadata: { # required
|
1248
|
-
# url: "IdpMetadataUrl",
|
1249
|
-
# xml: "String",
|
1250
|
-
# },
|
1251
|
-
# login_validity_duration: 1,
|
1252
|
-
# role_values: {
|
1253
|
-
# admin: ["RoleValue"],
|
1254
|
-
# editor: ["RoleValue"],
|
1255
|
-
# },
|
1256
|
-
# },
|
1257
|
-
# workspace_id: "WorkspaceId", # required
|
1258
|
-
# }
|
1259
|
-
#
|
1260
1084
|
# @!attribute [rw] authentication_providers
|
1261
|
-
# Specifies whether this workspace uses SAML 2.0,
|
1262
|
-
# Single Sign
|
1263
|
-
# console within a workspace. For more information,
|
1264
|
-
# authentication in Amazon Managed Grafana][1].
|
1085
|
+
# Specifies whether this workspace uses SAML 2.0, IAM Identity Center
|
1086
|
+
# (successor to Single Sign-On), or both to authenticate users for
|
1087
|
+
# using the Grafana console within a workspace. For more information,
|
1088
|
+
# see [User authentication in Amazon Managed Grafana][1].
|
1265
1089
|
#
|
1266
1090
|
#
|
1267
1091
|
#
|
@@ -1302,23 +1126,33 @@ module Aws::ManagedGrafana
|
|
1302
1126
|
include Aws::Structure
|
1303
1127
|
end
|
1304
1128
|
|
1305
|
-
#
|
1306
|
-
#
|
1307
|
-
#
|
1308
|
-
#
|
1309
|
-
#
|
1310
|
-
#
|
1311
|
-
#
|
1312
|
-
#
|
1313
|
-
#
|
1314
|
-
#
|
1315
|
-
#
|
1316
|
-
#
|
1317
|
-
#
|
1318
|
-
#
|
1319
|
-
#
|
1320
|
-
#
|
1129
|
+
# @!attribute [rw] configuration
|
1130
|
+
# The new configuration string for the workspace. For more information
|
1131
|
+
# about the format and configuration options available, see [Working
|
1132
|
+
# in your Grafana workspace][1].
|
1133
|
+
#
|
1134
|
+
#
|
1135
|
+
#
|
1136
|
+
# [1]: https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html
|
1137
|
+
# @return [String]
|
1138
|
+
#
|
1139
|
+
# @!attribute [rw] workspace_id
|
1140
|
+
# The ID of the workspace to update.
|
1141
|
+
# @return [String]
|
1142
|
+
#
|
1143
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/UpdateWorkspaceConfigurationRequest AWS API Documentation
|
1144
|
+
#
|
1145
|
+
class UpdateWorkspaceConfigurationRequest < Struct.new(
|
1146
|
+
:configuration,
|
1147
|
+
:workspace_id)
|
1148
|
+
SENSITIVE = []
|
1149
|
+
include Aws::Structure
|
1150
|
+
end
|
1151
|
+
|
1152
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/UpdateWorkspaceConfigurationResponse AWS API Documentation
|
1321
1153
|
#
|
1154
|
+
class UpdateWorkspaceConfigurationResponse < Aws::EmptyStructure; end
|
1155
|
+
|
1322
1156
|
# @!attribute [rw] account_access_type
|
1323
1157
|
# Specifies whether the workspace can access Amazon Web Services
|
1324
1158
|
# resources in this Amazon Web Services account only, or whether it
|
@@ -1355,11 +1189,23 @@ module Aws::ManagedGrafana
|
|
1355
1189
|
# [1]: https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html
|
1356
1190
|
# @return [String]
|
1357
1191
|
#
|
1192
|
+
# @!attribute [rw] remove_vpc_configuration
|
1193
|
+
# Whether to remove the VPC configuration from the workspace.
|
1194
|
+
#
|
1195
|
+
# Setting this to `true` and providing a `vpcConfiguration` to set
|
1196
|
+
# will return an error.
|
1197
|
+
# @return [Boolean]
|
1198
|
+
#
|
1358
1199
|
# @!attribute [rw] stack_set_name
|
1359
1200
|
# The name of the CloudFormation stack set to use to generate IAM
|
1360
1201
|
# roles to be used for this workspace.
|
1361
1202
|
# @return [String]
|
1362
1203
|
#
|
1204
|
+
# @!attribute [rw] vpc_configuration
|
1205
|
+
# The configuration settings for an Amazon VPC that contains data
|
1206
|
+
# sources for your Grafana workspace to connect to.
|
1207
|
+
# @return [Types::VpcConfiguration]
|
1208
|
+
#
|
1363
1209
|
# @!attribute [rw] workspace_data_sources
|
1364
1210
|
# Specify the Amazon Web Services data sources that you want to be
|
1365
1211
|
# queried in this workspace. Specifying these data sources here
|
@@ -1415,7 +1261,9 @@ module Aws::ManagedGrafana
|
|
1415
1261
|
:account_access_type,
|
1416
1262
|
:organization_role_name,
|
1417
1263
|
:permission_type,
|
1264
|
+
:remove_vpc_configuration,
|
1418
1265
|
:stack_set_name,
|
1266
|
+
:vpc_configuration,
|
1419
1267
|
:workspace_data_sources,
|
1420
1268
|
:workspace_description,
|
1421
1269
|
:workspace_id,
|
@@ -1441,14 +1289,6 @@ module Aws::ManagedGrafana
|
|
1441
1289
|
|
1442
1290
|
# A structure that specifies one user or group in the workspace.
|
1443
1291
|
#
|
1444
|
-
# @note When making an API call, you may pass User
|
1445
|
-
# data as a hash:
|
1446
|
-
#
|
1447
|
-
# {
|
1448
|
-
# id: "SsoId", # required
|
1449
|
-
# type: "SSO_USER", # required, accepts SSO_USER, SSO_GROUP
|
1450
|
-
# }
|
1451
|
-
#
|
1452
1292
|
# @!attribute [rw] id
|
1453
1293
|
# The ID of the user or group.
|
1454
1294
|
#
|
@@ -1513,6 +1353,28 @@ module Aws::ManagedGrafana
|
|
1513
1353
|
include Aws::Structure
|
1514
1354
|
end
|
1515
1355
|
|
1356
|
+
# The configuration settings for an Amazon VPC that contains data
|
1357
|
+
# sources for your Grafana workspace to connect to.
|
1358
|
+
#
|
1359
|
+
# @!attribute [rw] security_group_ids
|
1360
|
+
# The list of Amazon EC2 security group IDs attached to the Amazon VPC
|
1361
|
+
# for your Grafana workspace to connect.
|
1362
|
+
# @return [Array<String>]
|
1363
|
+
#
|
1364
|
+
# @!attribute [rw] subnet_ids
|
1365
|
+
# The list of Amazon EC2 subnet IDs created in the Amazon VPC for your
|
1366
|
+
# Grafana workspace to connect.
|
1367
|
+
# @return [Array<String>]
|
1368
|
+
#
|
1369
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/VpcConfiguration AWS API Documentation
|
1370
|
+
#
|
1371
|
+
class VpcConfiguration < Struct.new(
|
1372
|
+
:security_group_ids,
|
1373
|
+
:subnet_ids)
|
1374
|
+
SENSITIVE = []
|
1375
|
+
include Aws::Structure
|
1376
|
+
end
|
1377
|
+
|
1516
1378
|
# A structure containing information about an Amazon Managed Grafana
|
1517
1379
|
# workspace in your account.
|
1518
1380
|
#
|
@@ -1526,8 +1388,8 @@ module Aws::ManagedGrafana
|
|
1526
1388
|
# @return [String]
|
1527
1389
|
#
|
1528
1390
|
# @!attribute [rw] authentication
|
1529
|
-
# A structure that describes whether the workspace uses SAML,
|
1530
|
-
#
|
1391
|
+
# A structure that describes whether the workspace uses SAML, IAM
|
1392
|
+
# Identity Center, or both methods for user authentication.
|
1531
1393
|
# @return [Types::AuthenticationSummary]
|
1532
1394
|
#
|
1533
1395
|
# @!attribute [rw] created
|
@@ -1637,6 +1499,11 @@ module Aws::ManagedGrafana
|
|
1637
1499
|
# The list of tags associated with the workspace.
|
1638
1500
|
# @return [Hash<String,String>]
|
1639
1501
|
#
|
1502
|
+
# @!attribute [rw] vpc_configuration
|
1503
|
+
# The configuration for connecting to data sources in a private VPC
|
1504
|
+
# (Amazon Virtual Private Cloud).
|
1505
|
+
# @return [Types::VpcConfiguration]
|
1506
|
+
#
|
1640
1507
|
# @!attribute [rw] workspace_role_arn
|
1641
1508
|
# The IAM role that grants permissions to the Amazon Web Services
|
1642
1509
|
# resources that the workspace will view data from. This role must
|
@@ -1667,6 +1534,7 @@ module Aws::ManagedGrafana
|
|
1667
1534
|
:stack_set_name,
|
1668
1535
|
:status,
|
1669
1536
|
:tags,
|
1537
|
+
:vpc_configuration,
|
1670
1538
|
:workspace_role_arn)
|
1671
1539
|
SENSITIVE = [:description, :name, :organization_role_name, :organizational_units, :workspace_role_arn]
|
1672
1540
|
include Aws::Structure
|