github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/grafana/getWorkspace.go (about)

     1  // Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
     2  // *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***
     3  
     4  package grafana
     5  
     6  import (
     7  	"context"
     8  	"reflect"
     9  
    10  	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal"
    11  	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    12  )
    13  
    14  // Provides an Amazon Managed Grafana workspace data source.
    15  //
    16  // ## Example Usage
    17  //
    18  // ### Basic configuration
    19  //
    20  // <!--Start PulumiCodeChooser -->
    21  // ```go
    22  // package main
    23  //
    24  // import (
    25  //
    26  //	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/grafana"
    27  //	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    28  //
    29  // )
    30  //
    31  //	func main() {
    32  //		pulumi.Run(func(ctx *pulumi.Context) error {
    33  //			_, err := grafana.LookupWorkspace(ctx, &grafana.LookupWorkspaceArgs{
    34  //				WorkspaceId: "g-2054c75a02",
    35  //			}, nil)
    36  //			if err != nil {
    37  //				return err
    38  //			}
    39  //			return nil
    40  //		})
    41  //	}
    42  //
    43  // ```
    44  // <!--End PulumiCodeChooser -->
    45  func LookupWorkspace(ctx *pulumi.Context, args *LookupWorkspaceArgs, opts ...pulumi.InvokeOption) (*LookupWorkspaceResult, error) {
    46  	opts = internal.PkgInvokeDefaultOpts(opts)
    47  	var rv LookupWorkspaceResult
    48  	err := ctx.Invoke("aws:grafana/getWorkspace:getWorkspace", args, &rv, opts...)
    49  	if err != nil {
    50  		return nil, err
    51  	}
    52  	return &rv, nil
    53  }
    54  
    55  // A collection of arguments for invoking getWorkspace.
    56  type LookupWorkspaceArgs struct {
    57  	// Tags assigned to the resource
    58  	Tags map[string]string `pulumi:"tags"`
    59  	// Grafana workspace ID.
    60  	WorkspaceId string `pulumi:"workspaceId"`
    61  }
    62  
    63  // A collection of values returned by getWorkspace.
    64  type LookupWorkspaceResult struct {
    65  	// (Required) Type of account access for the workspace. Valid values are `CURRENT_ACCOUNT` and `ORGANIZATION`. If `ORGANIZATION` is specified, then `organizationalUnits` must also be present.
    66  	AccountAccessType string `pulumi:"accountAccessType"`
    67  	// ARN of the Grafana workspace.
    68  	Arn string `pulumi:"arn"`
    69  	// (Required) Authentication providers for the workspace. Valid values are `AWS_SSO`, `SAML`, or both.
    70  	AuthenticationProviders []string `pulumi:"authenticationProviders"`
    71  	// Creation date of the Grafana workspace.
    72  	CreatedDate string `pulumi:"createdDate"`
    73  	// Data sources for the workspace.
    74  	DataSources []string `pulumi:"dataSources"`
    75  	// Workspace description.
    76  	Description string `pulumi:"description"`
    77  	// Endpoint of the Grafana workspace.
    78  	Endpoint string `pulumi:"endpoint"`
    79  	// Version of Grafana running on the workspace.
    80  	GrafanaVersion string `pulumi:"grafanaVersion"`
    81  	// The provider-assigned unique ID for this managed resource.
    82  	Id string `pulumi:"id"`
    83  	// Last updated date of the Grafana workspace.
    84  	LastUpdatedDate string `pulumi:"lastUpdatedDate"`
    85  	// Grafana workspace name.
    86  	Name string `pulumi:"name"`
    87  	// The notification destinations.
    88  	NotificationDestinations []string `pulumi:"notificationDestinations"`
    89  	// The role name that the workspace uses to access resources through Amazon Organizations.
    90  	OrganizationRoleName string `pulumi:"organizationRoleName"`
    91  	// The Amazon Organizations organizational units that the workspace is authorized to use data sources from.
    92  	OrganizationalUnits []string `pulumi:"organizationalUnits"`
    93  	// Permission type of the workspace.
    94  	PermissionType string `pulumi:"permissionType"`
    95  	// IAM role ARN that the workspace assumes.
    96  	RoleArn                 string `pulumi:"roleArn"`
    97  	SamlConfigurationStatus string `pulumi:"samlConfigurationStatus"`
    98  	// AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
    99  	StackSetName string `pulumi:"stackSetName"`
   100  	// Status of the Grafana workspace.
   101  	Status string `pulumi:"status"`
   102  	// Tags assigned to the resource
   103  	Tags        map[string]string `pulumi:"tags"`
   104  	WorkspaceId string            `pulumi:"workspaceId"`
   105  }
   106  
   107  func LookupWorkspaceOutput(ctx *pulumi.Context, args LookupWorkspaceOutputArgs, opts ...pulumi.InvokeOption) LookupWorkspaceResultOutput {
   108  	return pulumi.ToOutputWithContext(context.Background(), args).
   109  		ApplyT(func(v interface{}) (LookupWorkspaceResult, error) {
   110  			args := v.(LookupWorkspaceArgs)
   111  			r, err := LookupWorkspace(ctx, &args, opts...)
   112  			var s LookupWorkspaceResult
   113  			if r != nil {
   114  				s = *r
   115  			}
   116  			return s, err
   117  		}).(LookupWorkspaceResultOutput)
   118  }
   119  
   120  // A collection of arguments for invoking getWorkspace.
   121  type LookupWorkspaceOutputArgs struct {
   122  	// Tags assigned to the resource
   123  	Tags pulumi.StringMapInput `pulumi:"tags"`
   124  	// Grafana workspace ID.
   125  	WorkspaceId pulumi.StringInput `pulumi:"workspaceId"`
   126  }
   127  
   128  func (LookupWorkspaceOutputArgs) ElementType() reflect.Type {
   129  	return reflect.TypeOf((*LookupWorkspaceArgs)(nil)).Elem()
   130  }
   131  
   132  // A collection of values returned by getWorkspace.
   133  type LookupWorkspaceResultOutput struct{ *pulumi.OutputState }
   134  
   135  func (LookupWorkspaceResultOutput) ElementType() reflect.Type {
   136  	return reflect.TypeOf((*LookupWorkspaceResult)(nil)).Elem()
   137  }
   138  
   139  func (o LookupWorkspaceResultOutput) ToLookupWorkspaceResultOutput() LookupWorkspaceResultOutput {
   140  	return o
   141  }
   142  
   143  func (o LookupWorkspaceResultOutput) ToLookupWorkspaceResultOutputWithContext(ctx context.Context) LookupWorkspaceResultOutput {
   144  	return o
   145  }
   146  
   147  // (Required) Type of account access for the workspace. Valid values are `CURRENT_ACCOUNT` and `ORGANIZATION`. If `ORGANIZATION` is specified, then `organizationalUnits` must also be present.
   148  func (o LookupWorkspaceResultOutput) AccountAccessType() pulumi.StringOutput {
   149  	return o.ApplyT(func(v LookupWorkspaceResult) string { return v.AccountAccessType }).(pulumi.StringOutput)
   150  }
   151  
   152  // ARN of the Grafana workspace.
   153  func (o LookupWorkspaceResultOutput) Arn() pulumi.StringOutput {
   154  	return o.ApplyT(func(v LookupWorkspaceResult) string { return v.Arn }).(pulumi.StringOutput)
   155  }
   156  
   157  // (Required) Authentication providers for the workspace. Valid values are `AWS_SSO`, `SAML`, or both.
   158  func (o LookupWorkspaceResultOutput) AuthenticationProviders() pulumi.StringArrayOutput {
   159  	return o.ApplyT(func(v LookupWorkspaceResult) []string { return v.AuthenticationProviders }).(pulumi.StringArrayOutput)
   160  }
   161  
   162  // Creation date of the Grafana workspace.
   163  func (o LookupWorkspaceResultOutput) CreatedDate() pulumi.StringOutput {
   164  	return o.ApplyT(func(v LookupWorkspaceResult) string { return v.CreatedDate }).(pulumi.StringOutput)
   165  }
   166  
   167  // Data sources for the workspace.
   168  func (o LookupWorkspaceResultOutput) DataSources() pulumi.StringArrayOutput {
   169  	return o.ApplyT(func(v LookupWorkspaceResult) []string { return v.DataSources }).(pulumi.StringArrayOutput)
   170  }
   171  
   172  // Workspace description.
   173  func (o LookupWorkspaceResultOutput) Description() pulumi.StringOutput {
   174  	return o.ApplyT(func(v LookupWorkspaceResult) string { return v.Description }).(pulumi.StringOutput)
   175  }
   176  
   177  // Endpoint of the Grafana workspace.
   178  func (o LookupWorkspaceResultOutput) Endpoint() pulumi.StringOutput {
   179  	return o.ApplyT(func(v LookupWorkspaceResult) string { return v.Endpoint }).(pulumi.StringOutput)
   180  }
   181  
   182  // Version of Grafana running on the workspace.
   183  func (o LookupWorkspaceResultOutput) GrafanaVersion() pulumi.StringOutput {
   184  	return o.ApplyT(func(v LookupWorkspaceResult) string { return v.GrafanaVersion }).(pulumi.StringOutput)
   185  }
   186  
   187  // The provider-assigned unique ID for this managed resource.
   188  func (o LookupWorkspaceResultOutput) Id() pulumi.StringOutput {
   189  	return o.ApplyT(func(v LookupWorkspaceResult) string { return v.Id }).(pulumi.StringOutput)
   190  }
   191  
   192  // Last updated date of the Grafana workspace.
   193  func (o LookupWorkspaceResultOutput) LastUpdatedDate() pulumi.StringOutput {
   194  	return o.ApplyT(func(v LookupWorkspaceResult) string { return v.LastUpdatedDate }).(pulumi.StringOutput)
   195  }
   196  
   197  // Grafana workspace name.
   198  func (o LookupWorkspaceResultOutput) Name() pulumi.StringOutput {
   199  	return o.ApplyT(func(v LookupWorkspaceResult) string { return v.Name }).(pulumi.StringOutput)
   200  }
   201  
   202  // The notification destinations.
   203  func (o LookupWorkspaceResultOutput) NotificationDestinations() pulumi.StringArrayOutput {
   204  	return o.ApplyT(func(v LookupWorkspaceResult) []string { return v.NotificationDestinations }).(pulumi.StringArrayOutput)
   205  }
   206  
   207  // The role name that the workspace uses to access resources through Amazon Organizations.
   208  func (o LookupWorkspaceResultOutput) OrganizationRoleName() pulumi.StringOutput {
   209  	return o.ApplyT(func(v LookupWorkspaceResult) string { return v.OrganizationRoleName }).(pulumi.StringOutput)
   210  }
   211  
   212  // The Amazon Organizations organizational units that the workspace is authorized to use data sources from.
   213  func (o LookupWorkspaceResultOutput) OrganizationalUnits() pulumi.StringArrayOutput {
   214  	return o.ApplyT(func(v LookupWorkspaceResult) []string { return v.OrganizationalUnits }).(pulumi.StringArrayOutput)
   215  }
   216  
   217  // Permission type of the workspace.
   218  func (o LookupWorkspaceResultOutput) PermissionType() pulumi.StringOutput {
   219  	return o.ApplyT(func(v LookupWorkspaceResult) string { return v.PermissionType }).(pulumi.StringOutput)
   220  }
   221  
   222  // IAM role ARN that the workspace assumes.
   223  func (o LookupWorkspaceResultOutput) RoleArn() pulumi.StringOutput {
   224  	return o.ApplyT(func(v LookupWorkspaceResult) string { return v.RoleArn }).(pulumi.StringOutput)
   225  }
   226  
   227  func (o LookupWorkspaceResultOutput) SamlConfigurationStatus() pulumi.StringOutput {
   228  	return o.ApplyT(func(v LookupWorkspaceResult) string { return v.SamlConfigurationStatus }).(pulumi.StringOutput)
   229  }
   230  
   231  // AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
   232  func (o LookupWorkspaceResultOutput) StackSetName() pulumi.StringOutput {
   233  	return o.ApplyT(func(v LookupWorkspaceResult) string { return v.StackSetName }).(pulumi.StringOutput)
   234  }
   235  
   236  // Status of the Grafana workspace.
   237  func (o LookupWorkspaceResultOutput) Status() pulumi.StringOutput {
   238  	return o.ApplyT(func(v LookupWorkspaceResult) string { return v.Status }).(pulumi.StringOutput)
   239  }
   240  
   241  // Tags assigned to the resource
   242  func (o LookupWorkspaceResultOutput) Tags() pulumi.StringMapOutput {
   243  	return o.ApplyT(func(v LookupWorkspaceResult) map[string]string { return v.Tags }).(pulumi.StringMapOutput)
   244  }
   245  
   246  func (o LookupWorkspaceResultOutput) WorkspaceId() pulumi.StringOutput {
   247  	return o.ApplyT(func(v LookupWorkspaceResult) string { return v.WorkspaceId }).(pulumi.StringOutput)
   248  }
   249  
   250  func init() {
   251  	pulumi.RegisterOutputType(LookupWorkspaceResultOutput{})
   252  }