AWS.Tools.ManagedGrafana.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.ManagedGrafana</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.MGRF.AddMGRFLicenseCmdlet"> <summary> Assigns a Grafana Enterprise license to a workspace. To upgrade, you must use <c>ENTERPRISE</c> for the <c>licenseType</c>, and pass in a valid Grafana Labs token for the <c>grafanaToken</c>. Upgrading to Grafana Enterprise incurs additional fees. For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html">Upgrade a workspace to Grafana Enterprise</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.AddMGRFLicenseCmdlet.GrafanaToken"> <summary> <para> <para>A token from Grafana Labs that ties your Amazon Web Services account with a Grafana Labs account. For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html#AMG-workspace-register-enterprise">Link your account with Grafana Labs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.AddMGRFLicenseCmdlet.LicenseType"> <summary> <para> <para>The type of license to associate with the workspace.</para><note><para>Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.AddMGRFLicenseCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace to associate the license with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.AddMGRFLicenseCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Workspace'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedGrafana.Model.AssociateLicenseResponse). Specifying the name of a property of type Amazon.ManagedGrafana.Model.AssociateLicenseResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.AddMGRFLicenseCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MGRF.AddMGRFResourceTagCmdlet"> <summary> The <c>TagResource</c> operation associates tags with an Amazon Managed Grafana resource. Currently, the only resource that can be tagged is workspaces. <para> If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.AddMGRFResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource the tag is associated with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.AddMGRFResourceTagCmdlet.Tag"> <summary> <para> <para>The list of tag keys and values to associate with the resource. You can associate tag keys only, tags (key and values) only or a combination of tag keys and tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.AddMGRFResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedGrafana.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.AddMGRFResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFPermissionListCmdlet"> <summary> Lists the users and groups who have the Grafana <c>Admin</c> and <c>Editor</c> roles in this workspace. If you use this operation without specifying <c>userId</c> or <c>groupId</c>, the operation returns the roles of all users and groups. If you specify a <c>userId</c> or a <c>groupId</c>, only the roles for that user or group are returned. If you do this, you can specify only one <c>userId</c> or one <c>groupId</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFPermissionListCmdlet.GroupId"> <summary> <para> <para>(Optional) Limits the results to only the group that matches this ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFPermissionListCmdlet.UserId"> <summary> <para> <para>(Optional) Limits the results to only the user that matches this ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFPermissionListCmdlet.UserType"> <summary> <para> <para>(Optional) If you specify <c>SSO_USER</c>, then only the permissions of IAM Identity Center users are returned. If you specify <c>SSO_GROUP</c>, only the permissions of IAM Identity Center groups are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFPermissionListCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace to list permissions for. This parameter is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFPermissionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to include in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFPermissionListCmdlet.NextToken"> <summary> <para> <para>The token to use when requesting the next set of results. You received this token from a previous <c>ListPermissions</c> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFPermissionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedGrafana.Model.ListPermissionsResponse). Specifying the name of a property of type Amazon.ManagedGrafana.Model.ListPermissionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFResourceTagCmdlet"> <summary> The <c>ListTagsForResource</c> operation returns the tags that are associated with the Amazon Managed Service for Grafana resource specified by the <c>resourceArn</c>. Currently, the only resource that can be tagged is a workspace. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource the list of tags are associated with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedGrafana.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.ManagedGrafana.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFVersionListCmdlet"> <summary> Lists available versions of Grafana. These are available when calling <c>CreateWorkspace</c>. Optionally, include a workspace to list the versions to which it can be upgraded. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFVersionListCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace to list the available upgrade versions. If not included, lists all versions of Grafana that are supported for <c>CreateWorkspace</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFVersionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to include in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFVersionListCmdlet.NextToken"> <summary> <para> <para>The token to use when requesting the next set of results. You receive this token from a previous <c>ListVersions</c> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GrafanaVersions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedGrafana.Model.ListVersionsResponse). Specifying the name of a property of type Amazon.ManagedGrafana.Model.ListVersionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFWorkspaceCmdlet"> <summary> Displays information about one Amazon Managed Grafana workspace. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFWorkspaceCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace to display information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFWorkspaceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Workspace'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedGrafana.Model.DescribeWorkspaceResponse). Specifying the name of a property of type Amazon.ManagedGrafana.Model.DescribeWorkspaceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFWorkspaceAuthenticationCmdlet"> <summary> Displays information about the authentication methods used in one Amazon Managed Grafana workspace. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFWorkspaceAuthenticationCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace to return authentication information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFWorkspaceAuthenticationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Authentication'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedGrafana.Model.DescribeWorkspaceAuthenticationResponse). Specifying the name of a property of type Amazon.ManagedGrafana.Model.DescribeWorkspaceAuthenticationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFWorkspaceConfigurationCmdlet"> <summary> Gets the current configuration string for the given workspace. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFWorkspaceConfigurationCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace to get configuration information for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFWorkspaceConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Configuration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedGrafana.Model.DescribeWorkspaceConfigurationResponse). Specifying the name of a property of type Amazon.ManagedGrafana.Model.DescribeWorkspaceConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFWorkspaceListCmdlet"> <summary> Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace. For more complete information about one workspace, use <a href="https://docs.aws.amazon.com/AAMG/latest/APIReference/API_DescribeWorkspace.html">DescribeWorkspace</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFWorkspaceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of workspaces to include in the results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFWorkspaceListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of workspaces to return. (You receive this token from a previous <c>ListWorkspaces</c> operation.)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFWorkspaceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Workspaces'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedGrafana.Model.ListWorkspacesResponse). Specifying the name of a property of type Amazon.ManagedGrafana.Model.ListWorkspacesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFWorkspaceServiceAccountListCmdlet"> <summary> Returns a list of service accounts for a workspace. <para> Service accounts are only available for workspaces that are compatible with Grafana version 9 and above. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFWorkspaceServiceAccountListCmdlet.WorkspaceId"> <summary> <para> <para>The workspace for which to list service accounts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFWorkspaceServiceAccountListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of service accounts to include in the results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFWorkspaceServiceAccountListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of service accounts to return. (You receive this token from a previous <c>ListWorkspaceServiceAccounts</c> operation.)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFWorkspaceServiceAccountListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedGrafana.Model.ListWorkspaceServiceAccountsResponse). Specifying the name of a property of type Amazon.ManagedGrafana.Model.ListWorkspaceServiceAccountsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFWorkspaceServiceAccountTokenListCmdlet"> <summary> Returns a list of tokens for a workspace service account. <note><para> This does not return the key for each token. You cannot access keys after they are created. To create a new key, delete the token and recreate it. </para></note><para> Service accounts are only available for workspaces that are compatible with Grafana version 9 and above. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFWorkspaceServiceAccountTokenListCmdlet.ServiceAccountId"> <summary> <para> <para>The ID of the service account for which to return tokens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFWorkspaceServiceAccountTokenListCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace for which to return tokens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFWorkspaceServiceAccountTokenListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of tokens to include in the results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFWorkspaceServiceAccountTokenListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of service accounts to return. (You receive this token from a previous <c>ListWorkspaceServiceAccountTokens</c> operation.)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.GetMGRFWorkspaceServiceAccountTokenListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedGrafana.Model.ListWorkspaceServiceAccountTokensResponse). Specifying the name of a property of type Amazon.ManagedGrafana.Model.ListWorkspaceServiceAccountTokensResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceCmdlet"> <summary> Creates a <i>workspace</i>. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces. You don't have to build, package, or deploy any hardware to run the Grafana server. <para> Don't use <c>CreateWorkspace</c> to modify an existing workspace. Instead, use <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdateWorkspace.html">UpdateWorkspace</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceCmdlet.AccountAccessType"> <summary> <para> <para>Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account only, or whether it can also access Amazon Web Services resources in other accounts in the same organization. If you specify <c>ORGANIZATION</c>, you must specify which organizational units the workspace can access in the <c>workspaceOrganizationalUnits</c> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceCmdlet.AuthenticationProvider"> <summary> <para> <para>Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html">User authentication in Amazon Managed Grafana</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceCmdlet.Configuration"> <summary> <para> <para>The configuration string for the workspace that you create. For more information about the format and configuration options available, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html">Working in your Grafana workspace</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceCmdlet.GrafanaVersion"> <summary> <para> <para>Specifies the version of Grafana to support in the new workspace. If not specified, defaults to the latest version (for example, 10.4).</para><para>To get a list of supported versions, use the <c>ListVersions</c> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceCmdlet.OrganizationRoleName"> <summary> <para> <para>The name of an IAM role that already exists to use with Organizations to access Amazon Web Services data sources and notification channels in other accounts in an organization.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceCmdlet.PermissionType"> <summary> <para> <para>When creating a workspace through the Amazon Web Services API, CLI or Amazon Web Services CloudFormation, you must manage IAM roles and provision the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.</para><para>You must also specify a <c>workspaceRoleArn</c> for a role that you will manage for the workspace to use when accessing those datasources and notification channels.</para><para>The ability for Amazon Managed Grafana to create and update IAM roles on behalf of the user is supported only in the Amazon Managed Grafana console, where this value may be set to <c>SERVICE_MANAGED</c>.</para><note><para>Use only the <c>CUSTOMER_MANAGED</c> permission type when creating a workspace with the API, CLI or Amazon Web Services CloudFormation. </para></note><para>For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html">Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceCmdlet.NetworkAccessControl_PrefixListId"> <summary> <para> <para>An array of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration (passed an empty array) then no IP addresses are allowed to access the workspace. You create a prefix list using the Amazon VPC console.</para><para>Prefix list IDs have the format <c>pl-<i>1a2b3c4d</i></c>.</para><para>For more information about prefix lists, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html">Group CIDR blocks using managed prefix lists</a>in the <i>Amazon Virtual Private Cloud User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceCmdlet.VpcConfiguration_SecurityGroupId"> <summary> <para> <para>The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceCmdlet.StackSetName"> <summary> <para> <para>The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceCmdlet.VpcConfiguration_SubnetId"> <summary> <para> <para>The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceCmdlet.Tag"> <summary> <para> <para>The list of tags associated with the workspace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceCmdlet.NetworkAccessControl_VpceId"> <summary> <para> <para>An array of Amazon VPC endpoint IDs for the workspace. You can create VPC endpoints to your Amazon Managed Grafana workspace for access from within a VPC. If a <c>NetworkAccessConfiguration</c> is specified then only VPC endpoints specified here are allowed to access the workspace. If you pass in an empty array of strings, then no VPCs are allowed to access the workspace.</para><para>VPC endpoint IDs have the format <c>vpce-<i>1a2b3c4d</i></c>.</para><para>For more information about creating an interface VPC endpoint, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/VPC-endpoints">Interface VPC endpoints</a> in the <i>Amazon Managed Grafana User Guide</i>.</para><note><para>The only VPC endpoints that can be specified here are interface VPC endpoints for Grafana workspaces (using the <c>com.amazonaws.[region].grafana-workspace</c> service endpoint). Other VPC endpoints are ignored.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceCmdlet.WorkspaceDataSource"> <summary> <para> <para>This parameter is for internal use only, and should not be used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceCmdlet.WorkspaceDescription"> <summary> <para> <para>A description for the workspace. This is used only to help you identify this workspace.</para><para>Pattern: <c>^[\\p{L}\\p{Z}\\p{N}\\p{P}]{0,2048}$</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceCmdlet.WorkspaceName"> <summary> <para> <para>The name for the workspace. It does not have to be unique.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceCmdlet.WorkspaceNotificationDestination"> <summary> <para> <para>Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceCmdlet.WorkspaceOrganizationalUnit"> <summary> <para> <para>Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceCmdlet.WorkspaceRoleArn"> <summary> <para> <para>Specified the IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from, including both data sources and notification channels. You are responsible for managing the permissions for this role as new data sources or notification channels are added. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Workspace'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedGrafana.Model.CreateWorkspaceResponse). Specifying the name of a property of type Amazon.ManagedGrafana.Model.CreateWorkspaceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceApiKeyCmdlet"> <summary> Creates a Grafana API key for the workspace. This key can be used to authenticate requests sent to the workspace's HTTP API. See <a href="https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html">https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html</a> for available APIs and example requests. <note><para> In workspaces compatible with Grafana version 9 or above, use workspace service accounts instead of API keys. API keys will be removed in a future release. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceApiKeyCmdlet.KeyName"> <summary> <para> <para>Specifies the name of the key. Keynames must be unique to the workspace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceApiKeyCmdlet.KeyRole"> <summary> <para> <para>Specifies the permission level of the key.</para><para> Valid values: <c>ADMIN</c>|<c>EDITOR</c>|<c>VIEWER</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceApiKeyCmdlet.SecondsToLive"> <summary> <para> <para>Specifies the time in seconds until the key expires. Keys can be valid for up to 30 days.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceApiKeyCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace to create an API key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceApiKeyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedGrafana.Model.CreateWorkspaceApiKeyResponse). Specifying the name of a property of type Amazon.ManagedGrafana.Model.CreateWorkspaceApiKeyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceApiKeyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceServiceAccountCmdlet"> <summary> Creates a service account for the workspace. A service account can be used to call Grafana HTTP APIs, and run automated workloads. After creating the service account with the correct <c>GrafanaRole</c> for your use case, use <c>CreateWorkspaceServiceAccountToken</c> to create a token that can be used to authenticate and authorize Grafana HTTP API calls. <para> You can only create service accounts for workspaces that are compatible with Grafana version 9 and above. </para><note><para> For more information about service accounts, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/service-accounts.html">Service accounts</a> in the <i>Amazon Managed Grafana User Guide</i>. </para><para> For more information about the Grafana HTTP APIs, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html">Using Grafana HTTP APIs</a> in the <i>Amazon Managed Grafana User Guide</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceServiceAccountCmdlet.GrafanaRole"> <summary> <para> <para>The permission level to use for this service account.</para><note><para>For more information about the roles and the permissions each has, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/Grafana-user-roles.html">User roles</a> in the <i>Amazon Managed Grafana User Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceServiceAccountCmdlet.Name"> <summary> <para> <para>A name for the service account. The name must be unique within the workspace, as it determines the ID associated with the service account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceServiceAccountCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace within which to create the service account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceServiceAccountCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedGrafana.Model.CreateWorkspaceServiceAccountResponse). Specifying the name of a property of type Amazon.ManagedGrafana.Model.CreateWorkspaceServiceAccountResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceServiceAccountCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceServiceAccountTokenCmdlet"> <summary> Creates a token that can be used to authenticate and authorize Grafana HTTP API operations for the given <a href="https://docs.aws.amazon.com/grafana/latest/userguide/service-accounts.html">workspace service account</a>. The service account acts as a user for the API operations, and defines the permissions that are used by the API. <important><para> When you create the service account token, you will receive a key that is used when calling Grafana APIs. Do not lose this key, as it will not be retrievable again. </para><para> If you do lose the key, you can delete the token and recreate it to receive a new key. This will disable the initial key. </para></important><para> Service accounts are only available for workspaces that are compatible with Grafana version 9 and above. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceServiceAccountTokenCmdlet.Name"> <summary> <para> <para>A name for the token to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceServiceAccountTokenCmdlet.SecondsToLive"> <summary> <para> <para>Sets how long the token will be valid, in seconds. You can set the time up to 30 days in the future.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceServiceAccountTokenCmdlet.ServiceAccountId"> <summary> <para> <para>The ID of the service account for which to create a token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceServiceAccountTokenCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace the service account resides within.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceServiceAccountTokenCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedGrafana.Model.CreateWorkspaceServiceAccountTokenResponse). Specifying the name of a property of type Amazon.ManagedGrafana.Model.CreateWorkspaceServiceAccountTokenResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.NewMGRFWorkspaceServiceAccountTokenCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFLicenseCmdlet"> <summary> Removes the Grafana Enterprise license from a workspace. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFLicenseCmdlet.LicenseType"> <summary> <para> <para>The type of license to remove from the workspace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFLicenseCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace to remove the Grafana Enterprise license from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFLicenseCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Workspace'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedGrafana.Model.DisassociateLicenseResponse). Specifying the name of a property of type Amazon.ManagedGrafana.Model.DisassociateLicenseResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFLicenseCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFResourceTagCmdlet"> <summary> The <c>UntagResource</c> operation removes the association of the tag with the Amazon Managed Grafana resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource the tag association is removed from. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFResourceTagCmdlet.TagKey"> <summary> <para> <para>The key values of the tag to be removed from the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedGrafana.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFWorkspaceCmdlet"> <summary> Deletes an Amazon Managed Grafana workspace. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFWorkspaceCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFWorkspaceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Workspace'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedGrafana.Model.DeleteWorkspaceResponse). Specifying the name of a property of type Amazon.ManagedGrafana.Model.DeleteWorkspaceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFWorkspaceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFWorkspaceApiKeyCmdlet"> <summary> Deletes a Grafana API key for the workspace. <note><para> In workspaces compatible with Grafana version 9 or above, use workspace service accounts instead of API keys. API keys will be removed in a future release. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFWorkspaceApiKeyCmdlet.KeyName"> <summary> <para> <para>The name of the API key to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFWorkspaceApiKeyCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFWorkspaceApiKeyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedGrafana.Model.DeleteWorkspaceApiKeyResponse). Specifying the name of a property of type Amazon.ManagedGrafana.Model.DeleteWorkspaceApiKeyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFWorkspaceApiKeyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFWorkspaceServiceAccountCmdlet"> <summary> Deletes a workspace service account from the workspace. <para> This will delete any tokens created for the service account, as well. If the tokens are currently in use, the will fail to authenticate / authorize after they are deleted. </para><para> Service accounts are only available for workspaces that are compatible with Grafana version 9 and above. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFWorkspaceServiceAccountCmdlet.ServiceAccountId"> <summary> <para> <para>The ID of the service account to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFWorkspaceServiceAccountCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace where the service account resides.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFWorkspaceServiceAccountCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedGrafana.Model.DeleteWorkspaceServiceAccountResponse). Specifying the name of a property of type Amazon.ManagedGrafana.Model.DeleteWorkspaceServiceAccountResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFWorkspaceServiceAccountCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFWorkspaceServiceAccountTokenCmdlet"> <summary> Deletes a token for the workspace service account. <para> This will disable the key associated with the token. If any automation is currently using the key, it will no longer be authenticated or authorized to perform actions with the Grafana HTTP APIs. </para><para> Service accounts are only available for workspaces that are compatible with Grafana version 9 and above. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFWorkspaceServiceAccountTokenCmdlet.ServiceAccountId"> <summary> <para> <para>The ID of the service account from which to delete the token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFWorkspaceServiceAccountTokenCmdlet.TokenId"> <summary> <para> <para>The ID of the token to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFWorkspaceServiceAccountTokenCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace from which to delete the token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFWorkspaceServiceAccountTokenCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedGrafana.Model.DeleteWorkspaceServiceAccountTokenResponse). Specifying the name of a property of type Amazon.ManagedGrafana.Model.DeleteWorkspaceServiceAccountTokenResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.RemoveMGRFWorkspaceServiceAccountTokenCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFPermissionCmdlet"> <summary> Updates which users in a workspace have the Grafana <c>Admin</c> or <c>Editor</c> roles. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFPermissionCmdlet.UpdateInstructionBatch"> <summary> <para> <para>An array of structures that contain the permission updates to make.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFPermissionCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFPermissionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Errors'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedGrafana.Model.UpdatePermissionsResponse). Specifying the name of a property of type Amazon.ManagedGrafana.Model.UpdatePermissionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFPermissionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceCmdlet"> <summary> Modifies an existing Amazon Managed Grafana workspace. If you use this operation and omit any optional parameters, the existing values of those parameters are not changed. <para> To modify the user authentication methods that the workspace uses, such as SAML or IAM Identity Center, use <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdateWorkspaceAuthentication.html">UpdateWorkspaceAuthentication</a>. </para><para> To modify which users in the workspace have the <c>Admin</c> and <c>Editor</c> Grafana roles, use <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html">UpdatePermissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceCmdlet.AccountAccessType"> <summary> <para> <para>Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account only, or whether it can also access Amazon Web Services resources in other accounts in the same organization. If you specify <c>ORGANIZATION</c>, you must specify which organizational units the workspace can access in the <c>workspaceOrganizationalUnits</c> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceCmdlet.OrganizationRoleName"> <summary> <para> <para>The name of an IAM role that already exists to use to access resources through Organizations. This can only be used with a workspace that has the <c>permissionType</c> set to <c>CUSTOMER_MANAGED</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceCmdlet.PermissionType"> <summary> <para> <para>Use this parameter if you want to change a workspace from <c>SERVICE_MANAGED</c> to <c>CUSTOMER_MANAGED</c>. This allows you to manage the permissions that the workspace uses to access datasources and notification channels. If the workspace is in a member Amazon Web Services account of an organization, and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, you must choose <c>CUSTOMER_MANAGED</c>.</para><para>If you specify this as <c>CUSTOMER_MANAGED</c>, you must also specify a <c>workspaceRoleArn</c> that the workspace will use for accessing Amazon Web Services resources.</para><para>For more information on the role and permissions needed, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html">Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels</a></para><note><para>Do not use this to convert a <c>CUSTOMER_MANAGED</c> workspace to <c>SERVICE_MANAGED</c>. Do not include this parameter if you want to leave the workspace as <c>SERVICE_MANAGED</c>.</para><para>You can convert a <c>CUSTOMER_MANAGED</c> workspace to <c>SERVICE_MANAGED</c> using the Amazon Managed Grafana console. For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-datasource-and-notification.html">Managing permissions for data sources and notification channels</a>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceCmdlet.NetworkAccessControl_PrefixListId"> <summary> <para> <para>An array of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration (passed an empty array) then no IP addresses are allowed to access the workspace. You create a prefix list using the Amazon VPC console.</para><para>Prefix list IDs have the format <c>pl-<i>1a2b3c4d</i></c>.</para><para>For more information about prefix lists, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html">Group CIDR blocks using managed prefix lists</a>in the <i>Amazon Virtual Private Cloud User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceCmdlet.RemoveNetworkAccessConfiguration"> <summary> <para> <para>Whether to remove the network access configuration from the workspace.</para><para>Setting this to <c>true</c> and providing a <c>networkAccessControl</c> to set will return an error.</para><para>If you remove this configuration by setting this to <c>true</c>, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceCmdlet.RemoveVpcConfiguration"> <summary> <para> <para>Whether to remove the VPC configuration from the workspace.</para><para>Setting this to <c>true</c> and providing a <c>vpcConfiguration</c> to set will return an error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceCmdlet.VpcConfiguration_SecurityGroupId"> <summary> <para> <para>The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceCmdlet.StackSetName"> <summary> <para> <para>The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceCmdlet.VpcConfiguration_SubnetId"> <summary> <para> <para>The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceCmdlet.NetworkAccessControl_VpceId"> <summary> <para> <para>An array of Amazon VPC endpoint IDs for the workspace. You can create VPC endpoints to your Amazon Managed Grafana workspace for access from within a VPC. If a <c>NetworkAccessConfiguration</c> is specified then only VPC endpoints specified here are allowed to access the workspace. If you pass in an empty array of strings, then no VPCs are allowed to access the workspace.</para><para>VPC endpoint IDs have the format <c>vpce-<i>1a2b3c4d</i></c>.</para><para>For more information about creating an interface VPC endpoint, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/VPC-endpoints">Interface VPC endpoints</a> in the <i>Amazon Managed Grafana User Guide</i>.</para><note><para>The only VPC endpoints that can be specified here are interface VPC endpoints for Grafana workspaces (using the <c>com.amazonaws.[region].grafana-workspace</c> service endpoint). Other VPC endpoints are ignored.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceCmdlet.WorkspaceDataSource"> <summary> <para> <para>This parameter is for internal use only, and should not be used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceCmdlet.WorkspaceDescription"> <summary> <para> <para>A description for the workspace. This is used only to help you identify this workspace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceCmdlet.WorkspaceName"> <summary> <para> <para>A new name for the workspace to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceCmdlet.WorkspaceNotificationDestination"> <summary> <para> <para>Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceCmdlet.WorkspaceOrganizationalUnit"> <summary> <para> <para>Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceCmdlet.WorkspaceRoleArn"> <summary> <para> <para>Specifies an IAM role that grants permissions to Amazon Web Services resources that the workspace accesses, such as data sources and notification channels. If this workspace has <c>permissionType</c><c>CUSTOMER_MANAGED</c>, then this role is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Workspace'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedGrafana.Model.UpdateWorkspaceResponse). Specifying the name of a property of type Amazon.ManagedGrafana.Model.UpdateWorkspaceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceAuthenticationCmdlet"> <summary> Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML. You can also map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the <c>Admin</c> and <c>Editor</c> roles in the workspace. <note><para> Changes to the authentication method for a workspace may take a few minutes to take effect. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceAuthenticationCmdlet.RoleValues_Admin"> <summary> <para> <para>A list of groups from the SAML assertion attribute to grant the Grafana <c>Admin</c> role to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceAuthenticationCmdlet.SamlConfiguration_AllowedOrganization"> <summary> <para> <para>Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace. If this is empty, all organizations in the assertion attribute have access.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceAuthenticationCmdlet.AuthenticationProvider"> <summary> <para> <para>Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html">User authentication in Amazon Managed Grafana</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceAuthenticationCmdlet.RoleValues_Editor"> <summary> <para> <para>A list of groups from the SAML assertion attribute to grant the Grafana <c>Editor</c> role to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceAuthenticationCmdlet.AssertionAttributes_Email"> <summary> <para> <para>The name of the attribute within the SAML assertion to use as the email names for SAML users.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceAuthenticationCmdlet.AssertionAttributes_Group"> <summary> <para> <para>The name of the attribute within the SAML assertion to use as the user full "friendly" names for user groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceAuthenticationCmdlet.AssertionAttributes_Login"> <summary> <para> <para>The name of the attribute within the SAML assertion to use as the login names for SAML users.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceAuthenticationCmdlet.SamlConfiguration_LoginValidityDuration"> <summary> <para> <para>How long a sign-on session by a SAML user is valid, before the user has to sign on again.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceAuthenticationCmdlet.AssertionAttributes_Name"> <summary> <para> <para>The name of the attribute within the SAML assertion to use as the user full "friendly" names for SAML users.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceAuthenticationCmdlet.AssertionAttributes_Org"> <summary> <para> <para>The name of the attribute within the SAML assertion to use as the user full "friendly" names for the users' organizations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceAuthenticationCmdlet.AssertionAttributes_Role"> <summary> <para> <para>The name of the attribute within the SAML assertion to use as the user roles.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceAuthenticationCmdlet.IdpMetadata_Url"> <summary> <para> <para>The URL of the location containing the IdP metadata.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceAuthenticationCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace to update the authentication for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceAuthenticationCmdlet.IdpMetadata_Xml"> <summary> <para> <para>The full IdP metadata, in XML format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceAuthenticationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Authentication'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedGrafana.Model.UpdateWorkspaceAuthenticationResponse). Specifying the name of a property of type Amazon.ManagedGrafana.Model.UpdateWorkspaceAuthenticationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceAuthenticationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceConfigurationCmdlet"> <summary> Updates the configuration string for the given workspace </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceConfigurationCmdlet.Configuration"> <summary> <para> <para>The new configuration string for the workspace. For more information about the format and configuration options available, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html">Working in your Grafana workspace</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceConfigurationCmdlet.GrafanaVersion"> <summary> <para> <para>Specifies the version of Grafana to support in the workspace. If not specified, keeps the current version of the workspace.</para><para>Can only be used to upgrade (for example, from 8.4 to 9.4), not downgrade (for example, from 9.4 to 8.4).</para><para>To know what versions are available to upgrade to for a specific workspace, see the <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_ListVersions.html">ListVersions</a> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceConfigurationCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedGrafana.Model.UpdateWorkspaceConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MGRF.UpdateMGRFWorkspaceConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |