grafana

package
v5.1.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 15, 2022 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type LicenseAssociation 

type LicenseAssociation struct {
	pulumi.CustomResourceState

	// If `licenseType` is set to `ENTERPRISE_FREE_TRIAL`, this is the expiration date of the free trial.
	FreeTrialExpiration pulumi.StringOutput `pulumi:"freeTrialExpiration"`
	// If `licenseType` is set to `ENTERPRISE`, this is the expiration date of the enterprise license.
	LicenseExpiration pulumi.StringOutput `pulumi:"licenseExpiration"`
	// The type of license for the workspace license association. Valid values are `ENTERPRISE` and `ENTERPRISE_FREE_TRIAL`.
	LicenseType pulumi.StringOutput `pulumi:"licenseType"`
	// The workspace id.
	WorkspaceId pulumi.StringOutput `pulumi:"workspaceId"`
}

Provides an Amazon Managed Grafana workspace license association resource.

## Example Usage ### Basic configuration

```go package main

import ( 

"encoding/json"

"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/grafana"
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/iam"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"Version": "2012-10-17",
			"Statement": []map[string]interface{}{
				map[string]interface{}{
					"Action": "sts:AssumeRole",
					"Effect": "Allow",
					"Sid":    "",
					"Principal": map[string]interface{}{
						"Service": "grafana.amazonaws.com",
					},
				},
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		assume, err := iam.NewRole(ctx, "assume", &iam.RoleArgs{
			AssumeRolePolicy: pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		exampleWorkspace, err := grafana.NewWorkspace(ctx, "exampleWorkspace", &grafana.WorkspaceArgs{
			AccountAccessType: pulumi.String("CURRENT_ACCOUNT"),
			AuthenticationProviders: pulumi.StringArray{
				pulumi.String("SAML"),
			},
			PermissionType: pulumi.String("SERVICE_MANAGED"),
			RoleArn:        assume.Arn,
		})
		if err != nil {
			return err
		}
		_, err = grafana.NewLicenseAssociation(ctx, "exampleLicenseAssociation", &grafana.LicenseAssociationArgs{
			LicenseType: pulumi.String("ENTERPRISE_FREE_TRIAL"),
			WorkspaceId: exampleWorkspace.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Grafana workspace license association can be imported using the workspace's `id`, e.g.,

```sh 

$ pulumi import aws:grafana/licenseAssociation:LicenseAssociation example g-2054c75a02

```

func GetLicenseAssociation 

func GetLicenseAssociation(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *LicenseAssociationState, opts ...pulumi.ResourceOption) (*LicenseAssociation, error)

GetLicenseAssociation gets an existing LicenseAssociation resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewLicenseAssociation 

func NewLicenseAssociation(ctx *pulumi.Context,
	name string, args *LicenseAssociationArgs, opts ...pulumi.ResourceOption) (*LicenseAssociation, error)

NewLicenseAssociation registers a new resource with the given unique name, arguments, and options.

func (*LicenseAssociation) ElementType 

func (*LicenseAssociation) ElementType() reflect.Type

func (*LicenseAssociation) ToLicenseAssociationOutput 

func (i *LicenseAssociation) ToLicenseAssociationOutput() LicenseAssociationOutput

func (*LicenseAssociation) ToLicenseAssociationOutputWithContext 

func (i *LicenseAssociation) ToLicenseAssociationOutputWithContext(ctx context.Context) LicenseAssociationOutput

type LicenseAssociationArgs 

type LicenseAssociationArgs struct {
	// The type of license for the workspace license association. Valid values are `ENTERPRISE` and `ENTERPRISE_FREE_TRIAL`.
	LicenseType pulumi.StringInput
	// The workspace id.
	WorkspaceId pulumi.StringInput
}

The set of arguments for constructing a LicenseAssociation resource.

func (LicenseAssociationArgs) ElementType 

func (LicenseAssociationArgs) ElementType() reflect.Type

type LicenseAssociationArray 

type LicenseAssociationArray []LicenseAssociationInput

func (LicenseAssociationArray) ElementType 

func (LicenseAssociationArray) ElementType() reflect.Type

func (LicenseAssociationArray) ToLicenseAssociationArrayOutput 

func (i LicenseAssociationArray) ToLicenseAssociationArrayOutput() LicenseAssociationArrayOutput

func (LicenseAssociationArray) ToLicenseAssociationArrayOutputWithContext 

func (i LicenseAssociationArray) ToLicenseAssociationArrayOutputWithContext(ctx context.Context) LicenseAssociationArrayOutput

type LicenseAssociationArrayInput 

type LicenseAssociationArrayInput interface {
	pulumi.Input

	ToLicenseAssociationArrayOutput() LicenseAssociationArrayOutput
	ToLicenseAssociationArrayOutputWithContext(context.Context) LicenseAssociationArrayOutput
}

LicenseAssociationArrayInput is an input type that accepts LicenseAssociationArray and LicenseAssociationArrayOutput values. You can construct a concrete instance of `LicenseAssociationArrayInput` via: 

LicenseAssociationArray{ LicenseAssociationArgs{...} }

type LicenseAssociationArrayOutput 

type LicenseAssociationArrayOutput struct{ *pulumi.OutputState }

func (LicenseAssociationArrayOutput) ElementType 

func (LicenseAssociationArrayOutput) ElementType() reflect.Type

func (LicenseAssociationArrayOutput) Index 

func (o LicenseAssociationArrayOutput) Index(i pulumi.IntInput) LicenseAssociationOutput

func (LicenseAssociationArrayOutput) ToLicenseAssociationArrayOutput 

func (o LicenseAssociationArrayOutput) ToLicenseAssociationArrayOutput() LicenseAssociationArrayOutput

func (LicenseAssociationArrayOutput) ToLicenseAssociationArrayOutputWithContext 

func (o LicenseAssociationArrayOutput) ToLicenseAssociationArrayOutputWithContext(ctx context.Context) LicenseAssociationArrayOutput

type LicenseAssociationInput 

type LicenseAssociationInput interface {
	pulumi.Input

	ToLicenseAssociationOutput() LicenseAssociationOutput
	ToLicenseAssociationOutputWithContext(ctx context.Context) LicenseAssociationOutput
}

type LicenseAssociationMap 

type LicenseAssociationMap map[string]LicenseAssociationInput

func (LicenseAssociationMap) ElementType 

func (LicenseAssociationMap) ElementType() reflect.Type

func (LicenseAssociationMap) ToLicenseAssociationMapOutput 

func (i LicenseAssociationMap) ToLicenseAssociationMapOutput() LicenseAssociationMapOutput

func (LicenseAssociationMap) ToLicenseAssociationMapOutputWithContext 

func (i LicenseAssociationMap) ToLicenseAssociationMapOutputWithContext(ctx context.Context) LicenseAssociationMapOutput

type LicenseAssociationMapInput 

type LicenseAssociationMapInput interface {
	pulumi.Input

	ToLicenseAssociationMapOutput() LicenseAssociationMapOutput
	ToLicenseAssociationMapOutputWithContext(context.Context) LicenseAssociationMapOutput
}

LicenseAssociationMapInput is an input type that accepts LicenseAssociationMap and LicenseAssociationMapOutput values. You can construct a concrete instance of `LicenseAssociationMapInput` via: 

LicenseAssociationMap{ "key": LicenseAssociationArgs{...} }

type LicenseAssociationMapOutput 

type LicenseAssociationMapOutput struct{ *pulumi.OutputState }

func (LicenseAssociationMapOutput) ElementType 

func (LicenseAssociationMapOutput) ElementType() reflect.Type

func (LicenseAssociationMapOutput) MapIndex 

func (o LicenseAssociationMapOutput) MapIndex(k pulumi.StringInput) LicenseAssociationOutput

func (LicenseAssociationMapOutput) ToLicenseAssociationMapOutput 

func (o LicenseAssociationMapOutput) ToLicenseAssociationMapOutput() LicenseAssociationMapOutput

func (LicenseAssociationMapOutput) ToLicenseAssociationMapOutputWithContext 

func (o LicenseAssociationMapOutput) ToLicenseAssociationMapOutputWithContext(ctx context.Context) LicenseAssociationMapOutput

type LicenseAssociationOutput 

type LicenseAssociationOutput struct{ *pulumi.OutputState }

func (LicenseAssociationOutput) ElementType 

func (LicenseAssociationOutput) ElementType() reflect.Type

func (LicenseAssociationOutput) ToLicenseAssociationOutput 

func (o LicenseAssociationOutput) ToLicenseAssociationOutput() LicenseAssociationOutput

func (LicenseAssociationOutput) ToLicenseAssociationOutputWithContext 

func (o LicenseAssociationOutput) ToLicenseAssociationOutputWithContext(ctx context.Context) LicenseAssociationOutput

type LicenseAssociationState 

type LicenseAssociationState struct {
	// If `licenseType` is set to `ENTERPRISE_FREE_TRIAL`, this is the expiration date of the free trial.
	FreeTrialExpiration pulumi.StringPtrInput
	// If `licenseType` is set to `ENTERPRISE`, this is the expiration date of the enterprise license.
	LicenseExpiration pulumi.StringPtrInput
	// The type of license for the workspace license association. Valid values are `ENTERPRISE` and `ENTERPRISE_FREE_TRIAL`.
	LicenseType pulumi.StringPtrInput
	// The workspace id.
	WorkspaceId pulumi.StringPtrInput
}

func (LicenseAssociationState) ElementType 

func (LicenseAssociationState) ElementType() reflect.Type

type LookupWorkspaceArgs 

type LookupWorkspaceArgs struct {
	// The Grafana workspace ID.
	WorkspaceId string `pulumi:"workspaceId"`
}

A collection of arguments for invoking getWorkspace.

type LookupWorkspaceOutputArgs 

type LookupWorkspaceOutputArgs struct {
	// The Grafana workspace ID.
	WorkspaceId pulumi.StringInput `pulumi:"workspaceId"`
}

A collection of arguments for invoking getWorkspace.

func (LookupWorkspaceOutputArgs) ElementType 

func (LookupWorkspaceOutputArgs) ElementType() reflect.Type

type LookupWorkspaceResult 

type LookupWorkspaceResult struct {
	// (Required) The type of account access for the workspace. Valid values are `CURRENT_ACCOUNT` and `ORGANIZATION`. If `ORGANIZATION` is specified, then `organizationalUnits` must also be present.
	AccountAccessType string `pulumi:"accountAccessType"`
	// The Amazon Resource Name (ARN) of the Grafana workspace.
	Arn string `pulumi:"arn"`
	// (Required) The authentication providers for the workspace. Valid values are `AWS_SSO`, `SAML`, or both.
	AuthenticationProviders []string `pulumi:"authenticationProviders"`
	// The creation date of the Grafana workspace.
	CreatedDate string `pulumi:"createdDate"`
	// The data sources for the workspace.
	DataSources []string `pulumi:"dataSources"`
	// The workspace description.
	Description string `pulumi:"description"`
	// The endpoint of the Grafana workspace.
	Endpoint string `pulumi:"endpoint"`
	// The version of Grafana running on the workspace.
	GrafanaVersion string `pulumi:"grafanaVersion"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The last updated date of the Grafana workspace.
	LastUpdatedDate string `pulumi:"lastUpdatedDate"`
	// The Grafana workspace name.
	Name string `pulumi:"name"`
	// The notification destinations.
	NotificationDestinations []string `pulumi:"notificationDestinations"`
	// The role name that the workspace uses to access resources through Amazon Organizations.
	OrganizationRoleName string `pulumi:"organizationRoleName"`
	// The Amazon Organizations organizational units that the workspace is authorized to use data sources from.
	OrganizationalUnits []string `pulumi:"organizationalUnits"`
	// The permission type of the workspace.
	PermissionType string `pulumi:"permissionType"`
	// The IAM role ARN that the workspace assumes.
	RoleArn                 string `pulumi:"roleArn"`
	SamlConfigurationStatus string `pulumi:"samlConfigurationStatus"`
	// The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
	StackSetName string `pulumi:"stackSetName"`
	// The status of the Grafana workspace.
	Status      string `pulumi:"status"`
	WorkspaceId string `pulumi:"workspaceId"`
}

A collection of values returned by getWorkspace.

func LookupWorkspace 

func LookupWorkspace(ctx *pulumi.Context, args *LookupWorkspaceArgs, opts ...pulumi.InvokeOption) (*LookupWorkspaceResult, error)

Provides an Amazon Managed Grafana workspace data source.

## Example Usage ### Basic configuration

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/grafana"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := grafana.LookupWorkspace(ctx, &grafana.LookupWorkspaceArgs{
			WorkspaceId: "g-2054c75a02",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type LookupWorkspaceResultOutput 

type LookupWorkspaceResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getWorkspace.

func LookupWorkspaceOutput 

func LookupWorkspaceOutput(ctx *pulumi.Context, args LookupWorkspaceOutputArgs, opts ...pulumi.InvokeOption) LookupWorkspaceResultOutput

func (LookupWorkspaceResultOutput) AccountAccessType 

func (o LookupWorkspaceResultOutput) AccountAccessType() pulumi.StringOutput

(Required) The type of account access for the workspace. Valid values are `CURRENT_ACCOUNT` and `ORGANIZATION`. If `ORGANIZATION` is specified, then `organizationalUnits` must also be present.

func (LookupWorkspaceResultOutput) Arn 

func (o LookupWorkspaceResultOutput) Arn() pulumi.StringOutput

The Amazon Resource Name (ARN) of the Grafana workspace.

func (LookupWorkspaceResultOutput) AuthenticationProviders 

func (o LookupWorkspaceResultOutput) AuthenticationProviders() pulumi.StringArrayOutput

(Required) The authentication providers for the workspace. Valid values are `AWS_SSO`, `SAML`, or both.

func (LookupWorkspaceResultOutput) CreatedDate 

func (o LookupWorkspaceResultOutput) CreatedDate() pulumi.StringOutput

The creation date of the Grafana workspace.

func (LookupWorkspaceResultOutput) DataSources 

func (o LookupWorkspaceResultOutput) DataSources() pulumi.StringArrayOutput

The data sources for the workspace.

func (LookupWorkspaceResultOutput) Description 

func (o LookupWorkspaceResultOutput) Description() pulumi.StringOutput

The workspace description.

func (LookupWorkspaceResultOutput) ElementType 

func (LookupWorkspaceResultOutput) ElementType() reflect.Type

func (LookupWorkspaceResultOutput) Endpoint 

func (o LookupWorkspaceResultOutput) Endpoint() pulumi.StringOutput

The endpoint of the Grafana workspace.

func (LookupWorkspaceResultOutput) GrafanaVersion 

func (o LookupWorkspaceResultOutput) GrafanaVersion() pulumi.StringOutput

The version of Grafana running on the workspace.

func (LookupWorkspaceResultOutput) Id 

func (o LookupWorkspaceResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (LookupWorkspaceResultOutput) LastUpdatedDate 

func (o LookupWorkspaceResultOutput) LastUpdatedDate() pulumi.StringOutput

The last updated date of the Grafana workspace.

func (LookupWorkspaceResultOutput) Name 

func (o LookupWorkspaceResultOutput) Name() pulumi.StringOutput

The Grafana workspace name.

func (LookupWorkspaceResultOutput) NotificationDestinations 

func (o LookupWorkspaceResultOutput) NotificationDestinations() pulumi.StringArrayOutput

The notification destinations.

func (LookupWorkspaceResultOutput) OrganizationRoleName 

func (o LookupWorkspaceResultOutput) OrganizationRoleName() pulumi.StringOutput

The role name that the workspace uses to access resources through Amazon Organizations.

func (LookupWorkspaceResultOutput) OrganizationalUnits 

func (o LookupWorkspaceResultOutput) OrganizationalUnits() pulumi.StringArrayOutput

The Amazon Organizations organizational units that the workspace is authorized to use data sources from.

func (LookupWorkspaceResultOutput) PermissionType 

func (o LookupWorkspaceResultOutput) PermissionType() pulumi.StringOutput

The permission type of the workspace.

func (LookupWorkspaceResultOutput) RoleArn 

func (o LookupWorkspaceResultOutput) RoleArn() pulumi.StringOutput

The IAM role ARN that the workspace assumes.

func (LookupWorkspaceResultOutput) SamlConfigurationStatus 

func (o LookupWorkspaceResultOutput) SamlConfigurationStatus() pulumi.StringOutput

func (LookupWorkspaceResultOutput) StackSetName 

func (o LookupWorkspaceResultOutput) StackSetName() pulumi.StringOutput

The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.

func (LookupWorkspaceResultOutput) Status 

func (o LookupWorkspaceResultOutput) Status() pulumi.StringOutput

The status of the Grafana workspace.

func (LookupWorkspaceResultOutput) ToLookupWorkspaceResultOutput 

func (o LookupWorkspaceResultOutput) ToLookupWorkspaceResultOutput() LookupWorkspaceResultOutput

func (LookupWorkspaceResultOutput) ToLookupWorkspaceResultOutputWithContext 

func (o LookupWorkspaceResultOutput) ToLookupWorkspaceResultOutputWithContext(ctx context.Context) LookupWorkspaceResultOutput

func (LookupWorkspaceResultOutput) WorkspaceId 

func (o LookupWorkspaceResultOutput) WorkspaceId() pulumi.StringOutput

type Workspace 

type Workspace struct {
	pulumi.CustomResourceState

	// The type of account access for the workspace. Valid values are `CURRENT_ACCOUNT` and `ORGANIZATION`. If `ORGANIZATION` is specified, then `organizationalUnits` must also be present.
	AccountAccessType pulumi.StringOutput `pulumi:"accountAccessType"`
	// The Amazon Resource Name (ARN) of the Grafana workspace.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The authentication providers for the workspace. Valid values are `AWS_SSO`, `SAML`, or both.
	AuthenticationProviders pulumi.StringArrayOutput `pulumi:"authenticationProviders"`
	// The data sources for the workspace. Valid values are `AMAZON_OPENSEARCH_SERVICE`, `CLOUDWATCH`, `PROMETHEUS`, `XRAY`, `TIMESTREAM`, `SITEWISE`.
	DataSources pulumi.StringArrayOutput `pulumi:"dataSources"`
	// The workspace description.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The endpoint of the Grafana workspace.
	Endpoint pulumi.StringOutput `pulumi:"endpoint"`
	// The version of Grafana running on the workspace.
	GrafanaVersion pulumi.StringOutput `pulumi:"grafanaVersion"`
	// The Grafana workspace name.
	Name pulumi.StringOutput `pulumi:"name"`
	// The notification destinations. If a data source is specified here, Amazon Managed Grafana will create IAM roles and permissions needed to use these destinations. Must be set to `SNS`.
	NotificationDestinations pulumi.StringArrayOutput `pulumi:"notificationDestinations"`
	// The role name that the workspace uses to access resources through Amazon Organizations.
	OrganizationRoleName pulumi.StringPtrOutput `pulumi:"organizationRoleName"`
	// The Amazon Organizations organizational units that the workspace is authorized to use data sources from.
	OrganizationalUnits pulumi.StringArrayOutput `pulumi:"organizationalUnits"`
	// The permission type of the workspace. If `SERVICE_MANAGED` is specified, the IAM roles and IAM policy attachments are generated automatically. If `CUSTOMER_MANAGED` is specified, the IAM roles and IAM policy attachments will not be created.
	PermissionType pulumi.StringOutput `pulumi:"permissionType"`
	// The IAM role ARN that the workspace assumes.
	RoleArn                 pulumi.StringPtrOutput `pulumi:"roleArn"`
	SamlConfigurationStatus pulumi.StringOutput    `pulumi:"samlConfigurationStatus"`
	// The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
	StackSetName pulumi.StringPtrOutput `pulumi:"stackSetName"`
}

Provides an Amazon Managed Grafana workspace resource.

## Example Usage ### Basic configuration

```go package main

import ( 

"encoding/json"

"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/grafana"
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/iam"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"Version": "2012-10-17",
			"Statement": []map[string]interface{}{
				map[string]interface{}{
					"Action": "sts:AssumeRole",
					"Effect": "Allow",
					"Sid":    "",
					"Principal": map[string]interface{}{
						"Service": "grafana.amazonaws.com",
					},
				},
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		assume, err := iam.NewRole(ctx, "assume", &iam.RoleArgs{
			AssumeRolePolicy: pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		_, err = grafana.NewWorkspace(ctx, "example", &grafana.WorkspaceArgs{
			AccountAccessType: pulumi.String("CURRENT_ACCOUNT"),
			AuthenticationProviders: pulumi.StringArray{
				pulumi.String("SAML"),
			},
			PermissionType: pulumi.String("SERVICE_MANAGED"),
			RoleArn:        assume.Arn,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Grafana Workspace can be imported using the workspace's `id`, e.g.,

```sh 

$ pulumi import aws:grafana/workspace:Workspace example g-2054c75a02

```

func GetWorkspace 

func GetWorkspace(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *WorkspaceState, opts ...pulumi.ResourceOption) (*Workspace, error)

GetWorkspace gets an existing Workspace resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewWorkspace 

func NewWorkspace(ctx *pulumi.Context,
	name string, args *WorkspaceArgs, opts ...pulumi.ResourceOption) (*Workspace, error)

NewWorkspace registers a new resource with the given unique name, arguments, and options.

func (*Workspace) ElementType 

func (*Workspace) ElementType() reflect.Type

func (*Workspace) ToWorkspaceOutput 

func (i *Workspace) ToWorkspaceOutput() WorkspaceOutput

func (*Workspace) ToWorkspaceOutputWithContext 

func (i *Workspace) ToWorkspaceOutputWithContext(ctx context.Context) WorkspaceOutput

type WorkspaceArgs 

type WorkspaceArgs struct {
	// The type of account access for the workspace. Valid values are `CURRENT_ACCOUNT` and `ORGANIZATION`. If `ORGANIZATION` is specified, then `organizationalUnits` must also be present.
	AccountAccessType pulumi.StringInput
	// The authentication providers for the workspace. Valid values are `AWS_SSO`, `SAML`, or both.
	AuthenticationProviders pulumi.StringArrayInput
	// The data sources for the workspace. Valid values are `AMAZON_OPENSEARCH_SERVICE`, `CLOUDWATCH`, `PROMETHEUS`, `XRAY`, `TIMESTREAM`, `SITEWISE`.
	DataSources pulumi.StringArrayInput
	// The workspace description.
	Description pulumi.StringPtrInput
	// The Grafana workspace name.
	Name pulumi.StringPtrInput
	// The notification destinations. If a data source is specified here, Amazon Managed Grafana will create IAM roles and permissions needed to use these destinations. Must be set to `SNS`.
	NotificationDestinations pulumi.StringArrayInput
	// The role name that the workspace uses to access resources through Amazon Organizations.
	OrganizationRoleName pulumi.StringPtrInput
	// The Amazon Organizations organizational units that the workspace is authorized to use data sources from.
	OrganizationalUnits pulumi.StringArrayInput
	// The permission type of the workspace. If `SERVICE_MANAGED` is specified, the IAM roles and IAM policy attachments are generated automatically. If `CUSTOMER_MANAGED` is specified, the IAM roles and IAM policy attachments will not be created.
	PermissionType pulumi.StringInput
	// The IAM role ARN that the workspace assumes.
	RoleArn pulumi.StringPtrInput
	// The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
	StackSetName pulumi.StringPtrInput
}

The set of arguments for constructing a Workspace resource.

func (WorkspaceArgs) ElementType 

func (WorkspaceArgs) ElementType() reflect.Type

type WorkspaceArray 

type WorkspaceArray []WorkspaceInput

func (WorkspaceArray) ElementType 

func (WorkspaceArray) ElementType() reflect.Type

func (WorkspaceArray) ToWorkspaceArrayOutput 

func (i WorkspaceArray) ToWorkspaceArrayOutput() WorkspaceArrayOutput

func (WorkspaceArray) ToWorkspaceArrayOutputWithContext 

func (i WorkspaceArray) ToWorkspaceArrayOutputWithContext(ctx context.Context) WorkspaceArrayOutput

type WorkspaceArrayInput 

type WorkspaceArrayInput interface {
	pulumi.Input

	ToWorkspaceArrayOutput() WorkspaceArrayOutput
	ToWorkspaceArrayOutputWithContext(context.Context) WorkspaceArrayOutput
}

WorkspaceArrayInput is an input type that accepts WorkspaceArray and WorkspaceArrayOutput values. You can construct a concrete instance of `WorkspaceArrayInput` via: 

WorkspaceArray{ WorkspaceArgs{...} }

type WorkspaceArrayOutput 

type WorkspaceArrayOutput struct{ *pulumi.OutputState }

func (WorkspaceArrayOutput) ElementType 

func (WorkspaceArrayOutput) ElementType() reflect.Type

func (WorkspaceArrayOutput) Index 

func (o WorkspaceArrayOutput) Index(i pulumi.IntInput) WorkspaceOutput

func (WorkspaceArrayOutput) ToWorkspaceArrayOutput 

func (o WorkspaceArrayOutput) ToWorkspaceArrayOutput() WorkspaceArrayOutput

func (WorkspaceArrayOutput) ToWorkspaceArrayOutputWithContext 

func (o WorkspaceArrayOutput) ToWorkspaceArrayOutputWithContext(ctx context.Context) WorkspaceArrayOutput

type WorkspaceInput 

type WorkspaceInput interface {
	pulumi.Input

	ToWorkspaceOutput() WorkspaceOutput
	ToWorkspaceOutputWithContext(ctx context.Context) WorkspaceOutput
}

type WorkspaceMap 

type WorkspaceMap map[string]WorkspaceInput

func (WorkspaceMap) ElementType 

func (WorkspaceMap) ElementType() reflect.Type

func (WorkspaceMap) ToWorkspaceMapOutput 

func (i WorkspaceMap) ToWorkspaceMapOutput() WorkspaceMapOutput

func (WorkspaceMap) ToWorkspaceMapOutputWithContext 

func (i WorkspaceMap) ToWorkspaceMapOutputWithContext(ctx context.Context) WorkspaceMapOutput

type WorkspaceMapInput 

type WorkspaceMapInput interface {
	pulumi.Input

	ToWorkspaceMapOutput() WorkspaceMapOutput
	ToWorkspaceMapOutputWithContext(context.Context) WorkspaceMapOutput
}

WorkspaceMapInput is an input type that accepts WorkspaceMap and WorkspaceMapOutput values. You can construct a concrete instance of `WorkspaceMapInput` via: 

WorkspaceMap{ "key": WorkspaceArgs{...} }

type WorkspaceMapOutput 

type WorkspaceMapOutput struct{ *pulumi.OutputState }

func (WorkspaceMapOutput) ElementType 

func (WorkspaceMapOutput) ElementType() reflect.Type

func (WorkspaceMapOutput) MapIndex 

func (o WorkspaceMapOutput) MapIndex(k pulumi.StringInput) WorkspaceOutput

func (WorkspaceMapOutput) ToWorkspaceMapOutput 

func (o WorkspaceMapOutput) ToWorkspaceMapOutput() WorkspaceMapOutput

func (WorkspaceMapOutput) ToWorkspaceMapOutputWithContext 

func (o WorkspaceMapOutput) ToWorkspaceMapOutputWithContext(ctx context.Context) WorkspaceMapOutput

type WorkspaceOutput 

type WorkspaceOutput struct{ *pulumi.OutputState }

func (WorkspaceOutput) ElementType 

func (WorkspaceOutput) ElementType() reflect.Type

func (WorkspaceOutput) ToWorkspaceOutput 

func (o WorkspaceOutput) ToWorkspaceOutput() WorkspaceOutput

func (WorkspaceOutput) ToWorkspaceOutputWithContext 

func (o WorkspaceOutput) ToWorkspaceOutputWithContext(ctx context.Context) WorkspaceOutput

type WorkspaceSamlConfiguration 

type WorkspaceSamlConfiguration struct {
	pulumi.CustomResourceState

	// The admin role values.
	AdminRoleValues pulumi.StringArrayOutput `pulumi:"adminRoleValues"`
	// The allowed organizations.
	AllowedOrganizations pulumi.StringArrayOutput `pulumi:"allowedOrganizations"`
	// The editor role values.
	EditorRoleValues pulumi.StringArrayOutput `pulumi:"editorRoleValues"`
	// The email assertion.
	EmailAssertion pulumi.StringOutput `pulumi:"emailAssertion"`
	// The groups assertion.
	GroupsAssertion pulumi.StringPtrOutput `pulumi:"groupsAssertion"`
	// The IDP Metadata URL. Note that either `idpMetadataUrl` or `idpMetadataXml` (but not both) must be specified.
	IdpMetadataUrl pulumi.StringPtrOutput `pulumi:"idpMetadataUrl"`
	// The IDP Metadata XML. Note that either `idpMetadataUrl` or `idpMetadataXml` (but not both) must be specified.
	IdpMetadataXml pulumi.StringPtrOutput `pulumi:"idpMetadataXml"`
	// The login assertion.
	LoginAssertion pulumi.StringOutput `pulumi:"loginAssertion"`
	// The login validity duration.
	LoginValidityDuration pulumi.IntOutput `pulumi:"loginValidityDuration"`
	// The name assertion.
	NameAssertion pulumi.StringOutput `pulumi:"nameAssertion"`
	// The org assertion.
	OrgAssertion pulumi.StringPtrOutput `pulumi:"orgAssertion"`
	// The role assertion.
	RoleAssertion pulumi.StringPtrOutput `pulumi:"roleAssertion"`
	// The status of the SAML configuration.
	Status pulumi.StringOutput `pulumi:"status"`
	// The workspace id.
	WorkspaceId pulumi.StringOutput `pulumi:"workspaceId"`
}

Provides an Amazon Managed Grafana workspace SAML configuration resource.

## Example Usage ### Basic configuration

```go package main

import ( 

"encoding/json"

"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/grafana"
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/iam"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"Version": "2012-10-17",
			"Statement": []map[string]interface{}{
				map[string]interface{}{
					"Action": "sts:AssumeRole",
					"Effect": "Allow",
					"Sid":    "",
					"Principal": map[string]interface{}{
						"Service": "grafana.amazonaws.com",
					},
				},
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		assume, err := iam.NewRole(ctx, "assume", &iam.RoleArgs{
			AssumeRolePolicy: pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		exampleWorkspace, err := grafana.NewWorkspace(ctx, "exampleWorkspace", &grafana.WorkspaceArgs{
			AccountAccessType: pulumi.String("CURRENT_ACCOUNT"),
			AuthenticationProviders: pulumi.StringArray{
				pulumi.String("SAML"),
			},
			PermissionType: pulumi.String("SERVICE_MANAGED"),
			RoleArn:        assume.Arn,
		})
		if err != nil {
			return err
		}
		_, err = grafana.NewWorkspaceSamlConfiguration(ctx, "exampleWorkspaceSamlConfiguration", &grafana.WorkspaceSamlConfigurationArgs{
			EditorRoleValues: pulumi.StringArray{
				pulumi.String("editor"),
			},
			IdpMetadataUrl: pulumi.String("https://my_idp_metadata.url"),
			WorkspaceId:    exampleWorkspace.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Grafana Workspace SAML configuration can be imported using the workspace's `id`, e.g.,

```sh 

$ pulumi import aws:grafana/workspaceSamlConfiguration:WorkspaceSamlConfiguration example g-2054c75a02

```

func GetWorkspaceSamlConfiguration 

func GetWorkspaceSamlConfiguration(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *WorkspaceSamlConfigurationState, opts ...pulumi.ResourceOption) (*WorkspaceSamlConfiguration, error)

GetWorkspaceSamlConfiguration gets an existing WorkspaceSamlConfiguration resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewWorkspaceSamlConfiguration 

func NewWorkspaceSamlConfiguration(ctx *pulumi.Context,
	name string, args *WorkspaceSamlConfigurationArgs, opts ...pulumi.ResourceOption) (*WorkspaceSamlConfiguration, error)

NewWorkspaceSamlConfiguration registers a new resource with the given unique name, arguments, and options.

func (*WorkspaceSamlConfiguration) ElementType 

func (*WorkspaceSamlConfiguration) ElementType() reflect.Type

func (*WorkspaceSamlConfiguration) ToWorkspaceSamlConfigurationOutput 

func (i *WorkspaceSamlConfiguration) ToWorkspaceSamlConfigurationOutput() WorkspaceSamlConfigurationOutput

func (*WorkspaceSamlConfiguration) ToWorkspaceSamlConfigurationOutputWithContext 

func (i *WorkspaceSamlConfiguration) ToWorkspaceSamlConfigurationOutputWithContext(ctx context.Context) WorkspaceSamlConfigurationOutput

type WorkspaceSamlConfigurationArgs 

type WorkspaceSamlConfigurationArgs struct {
	// The admin role values.
	AdminRoleValues pulumi.StringArrayInput
	// The allowed organizations.
	AllowedOrganizations pulumi.StringArrayInput
	// The editor role values.
	EditorRoleValues pulumi.StringArrayInput
	// The email assertion.
	EmailAssertion pulumi.StringPtrInput
	// The groups assertion.
	GroupsAssertion pulumi.StringPtrInput
	// The IDP Metadata URL. Note that either `idpMetadataUrl` or `idpMetadataXml` (but not both) must be specified.
	IdpMetadataUrl pulumi.StringPtrInput
	// The IDP Metadata XML. Note that either `idpMetadataUrl` or `idpMetadataXml` (but not both) must be specified.
	IdpMetadataXml pulumi.StringPtrInput
	// The login assertion.
	LoginAssertion pulumi.StringPtrInput
	// The login validity duration.
	LoginValidityDuration pulumi.IntPtrInput
	// The name assertion.
	NameAssertion pulumi.StringPtrInput
	// The org assertion.
	OrgAssertion pulumi.StringPtrInput
	// The role assertion.
	RoleAssertion pulumi.StringPtrInput
	// The workspace id.
	WorkspaceId pulumi.StringInput
}

The set of arguments for constructing a WorkspaceSamlConfiguration resource.

func (WorkspaceSamlConfigurationArgs) ElementType 

func (WorkspaceSamlConfigurationArgs) ElementType() reflect.Type

type WorkspaceSamlConfigurationArray 

type WorkspaceSamlConfigurationArray []WorkspaceSamlConfigurationInput

func (WorkspaceSamlConfigurationArray) ElementType 

func (WorkspaceSamlConfigurationArray) ElementType() reflect.Type

func (WorkspaceSamlConfigurationArray) ToWorkspaceSamlConfigurationArrayOutput 

func (i WorkspaceSamlConfigurationArray) ToWorkspaceSamlConfigurationArrayOutput() WorkspaceSamlConfigurationArrayOutput

func (WorkspaceSamlConfigurationArray) ToWorkspaceSamlConfigurationArrayOutputWithContext 

func (i WorkspaceSamlConfigurationArray) ToWorkspaceSamlConfigurationArrayOutputWithContext(ctx context.Context) WorkspaceSamlConfigurationArrayOutput

type WorkspaceSamlConfigurationArrayInput 

type WorkspaceSamlConfigurationArrayInput interface {
	pulumi.Input

	ToWorkspaceSamlConfigurationArrayOutput() WorkspaceSamlConfigurationArrayOutput
	ToWorkspaceSamlConfigurationArrayOutputWithContext(context.Context) WorkspaceSamlConfigurationArrayOutput
}

WorkspaceSamlConfigurationArrayInput is an input type that accepts WorkspaceSamlConfigurationArray and WorkspaceSamlConfigurationArrayOutput values. You can construct a concrete instance of `WorkspaceSamlConfigurationArrayInput` via: 

WorkspaceSamlConfigurationArray{ WorkspaceSamlConfigurationArgs{...} }

type WorkspaceSamlConfigurationArrayOutput 

type WorkspaceSamlConfigurationArrayOutput struct{ *pulumi.OutputState }

func (WorkspaceSamlConfigurationArrayOutput) ElementType 

func (WorkspaceSamlConfigurationArrayOutput) ElementType() reflect.Type

func (WorkspaceSamlConfigurationArrayOutput) Index 

func (o WorkspaceSamlConfigurationArrayOutput) Index(i pulumi.IntInput) WorkspaceSamlConfigurationOutput

func (WorkspaceSamlConfigurationArrayOutput) ToWorkspaceSamlConfigurationArrayOutput 

func (o WorkspaceSamlConfigurationArrayOutput) ToWorkspaceSamlConfigurationArrayOutput() WorkspaceSamlConfigurationArrayOutput

func (WorkspaceSamlConfigurationArrayOutput) ToWorkspaceSamlConfigurationArrayOutputWithContext 

func (o WorkspaceSamlConfigurationArrayOutput) ToWorkspaceSamlConfigurationArrayOutputWithContext(ctx context.Context) WorkspaceSamlConfigurationArrayOutput

type WorkspaceSamlConfigurationInput 

type WorkspaceSamlConfigurationInput interface {
	pulumi.Input

	ToWorkspaceSamlConfigurationOutput() WorkspaceSamlConfigurationOutput
	ToWorkspaceSamlConfigurationOutputWithContext(ctx context.Context) WorkspaceSamlConfigurationOutput
}

type WorkspaceSamlConfigurationMap 

type WorkspaceSamlConfigurationMap map[string]WorkspaceSamlConfigurationInput

func (WorkspaceSamlConfigurationMap) ElementType 

func (WorkspaceSamlConfigurationMap) ElementType() reflect.Type

func (WorkspaceSamlConfigurationMap) ToWorkspaceSamlConfigurationMapOutput 

func (i WorkspaceSamlConfigurationMap) ToWorkspaceSamlConfigurationMapOutput() WorkspaceSamlConfigurationMapOutput

func (WorkspaceSamlConfigurationMap) ToWorkspaceSamlConfigurationMapOutputWithContext 

func (i WorkspaceSamlConfigurationMap) ToWorkspaceSamlConfigurationMapOutputWithContext(ctx context.Context) WorkspaceSamlConfigurationMapOutput

type WorkspaceSamlConfigurationMapInput 

type WorkspaceSamlConfigurationMapInput interface {
	pulumi.Input

	ToWorkspaceSamlConfigurationMapOutput() WorkspaceSamlConfigurationMapOutput
	ToWorkspaceSamlConfigurationMapOutputWithContext(context.Context) WorkspaceSamlConfigurationMapOutput
}

WorkspaceSamlConfigurationMapInput is an input type that accepts WorkspaceSamlConfigurationMap and WorkspaceSamlConfigurationMapOutput values. You can construct a concrete instance of `WorkspaceSamlConfigurationMapInput` via: 

WorkspaceSamlConfigurationMap{ "key": WorkspaceSamlConfigurationArgs{...} }

type WorkspaceSamlConfigurationMapOutput 

type WorkspaceSamlConfigurationMapOutput struct{ *pulumi.OutputState }

func (WorkspaceSamlConfigurationMapOutput) ElementType 

func (WorkspaceSamlConfigurationMapOutput) ElementType() reflect.Type

func (WorkspaceSamlConfigurationMapOutput) MapIndex 

func (o WorkspaceSamlConfigurationMapOutput) MapIndex(k pulumi.StringInput) WorkspaceSamlConfigurationOutput

func (WorkspaceSamlConfigurationMapOutput) ToWorkspaceSamlConfigurationMapOutput 

func (o WorkspaceSamlConfigurationMapOutput) ToWorkspaceSamlConfigurationMapOutput() WorkspaceSamlConfigurationMapOutput

func (WorkspaceSamlConfigurationMapOutput) ToWorkspaceSamlConfigurationMapOutputWithContext 

func (o WorkspaceSamlConfigurationMapOutput) ToWorkspaceSamlConfigurationMapOutputWithContext(ctx context.Context) WorkspaceSamlConfigurationMapOutput

type WorkspaceSamlConfigurationOutput 

type WorkspaceSamlConfigurationOutput struct{ *pulumi.OutputState }

func (WorkspaceSamlConfigurationOutput) ElementType 

func (WorkspaceSamlConfigurationOutput) ElementType() reflect.Type

func (WorkspaceSamlConfigurationOutput) ToWorkspaceSamlConfigurationOutput 

func (o WorkspaceSamlConfigurationOutput) ToWorkspaceSamlConfigurationOutput() WorkspaceSamlConfigurationOutput

func (WorkspaceSamlConfigurationOutput) ToWorkspaceSamlConfigurationOutputWithContext 

func (o WorkspaceSamlConfigurationOutput) ToWorkspaceSamlConfigurationOutputWithContext(ctx context.Context) WorkspaceSamlConfigurationOutput

type WorkspaceSamlConfigurationState 

type WorkspaceSamlConfigurationState struct {
	// The admin role values.
	AdminRoleValues pulumi.StringArrayInput
	// The allowed organizations.
	AllowedOrganizations pulumi.StringArrayInput
	// The editor role values.
	EditorRoleValues pulumi.StringArrayInput
	// The email assertion.
	EmailAssertion pulumi.StringPtrInput
	// The groups assertion.
	GroupsAssertion pulumi.StringPtrInput
	// The IDP Metadata URL. Note that either `idpMetadataUrl` or `idpMetadataXml` (but not both) must be specified.
	IdpMetadataUrl pulumi.StringPtrInput
	// The IDP Metadata XML. Note that either `idpMetadataUrl` or `idpMetadataXml` (but not both) must be specified.
	IdpMetadataXml pulumi.StringPtrInput
	// The login assertion.
	LoginAssertion pulumi.StringPtrInput
	// The login validity duration.
	LoginValidityDuration pulumi.IntPtrInput
	// The name assertion.
	NameAssertion pulumi.StringPtrInput
	// The org assertion.
	OrgAssertion pulumi.StringPtrInput
	// The role assertion.
	RoleAssertion pulumi.StringPtrInput
	// The status of the SAML configuration.
	Status pulumi.StringPtrInput
	// The workspace id.
	WorkspaceId pulumi.StringPtrInput
}

func (WorkspaceSamlConfigurationState) ElementType 

func (WorkspaceSamlConfigurationState) ElementType() reflect.Type

type WorkspaceState 

type WorkspaceState struct {
	// The type of account access for the workspace. Valid values are `CURRENT_ACCOUNT` and `ORGANIZATION`. If `ORGANIZATION` is specified, then `organizationalUnits` must also be present.
	AccountAccessType pulumi.StringPtrInput
	// The Amazon Resource Name (ARN) of the Grafana workspace.
	Arn pulumi.StringPtrInput
	// The authentication providers for the workspace. Valid values are `AWS_SSO`, `SAML`, or both.
	AuthenticationProviders pulumi.StringArrayInput
	// The data sources for the workspace. Valid values are `AMAZON_OPENSEARCH_SERVICE`, `CLOUDWATCH`, `PROMETHEUS`, `XRAY`, `TIMESTREAM`, `SITEWISE`.
	DataSources pulumi.StringArrayInput
	// The workspace description.
	Description pulumi.StringPtrInput
	// The endpoint of the Grafana workspace.
	Endpoint pulumi.StringPtrInput
	// The version of Grafana running on the workspace.
	GrafanaVersion pulumi.StringPtrInput
	// The Grafana workspace name.
	Name pulumi.StringPtrInput
	// The notification destinations. If a data source is specified here, Amazon Managed Grafana will create IAM roles and permissions needed to use these destinations. Must be set to `SNS`.
	NotificationDestinations pulumi.StringArrayInput
	// The role name that the workspace uses to access resources through Amazon Organizations.
	OrganizationRoleName pulumi.StringPtrInput
	// The Amazon Organizations organizational units that the workspace is authorized to use data sources from.
	OrganizationalUnits pulumi.StringArrayInput
	// The permission type of the workspace. If `SERVICE_MANAGED` is specified, the IAM roles and IAM policy attachments are generated automatically. If `CUSTOMER_MANAGED` is specified, the IAM roles and IAM policy attachments will not be created.
	PermissionType pulumi.StringPtrInput
	// The IAM role ARN that the workspace assumes.
	RoleArn                 pulumi.StringPtrInput
	SamlConfigurationStatus pulumi.StringPtrInput
	// The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
	StackSetName pulumi.StringPtrInput
}

func (WorkspaceState) ElementType 

func (WorkspaceState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.