provider

README

provider

Refer to the Terraform Registory for docs: googleworkspace.

Documentation

Index

• func GoogleworkspaceProvider_IsConstruct(x interface{}) *bool
• func GoogleworkspaceProvider_TfResourceType() *string
• func NewGoogleworkspaceProvider_Override(g GoogleworkspaceProvider, scope constructs.Construct, id *string, ...)
• type GoogleworkspaceProvider
  • func NewGoogleworkspaceProvider(scope constructs.Construct, id *string, config *GoogleworkspaceProviderConfig) GoogleworkspaceProvider
• type GoogleworkspaceProviderConfig

Functions

func GoogleworkspaceProvider_IsConstruct

func GoogleworkspaceProvider_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

func GoogleworkspaceProvider_TfResourceType

func GoogleworkspaceProvider_TfResourceType() *string

func NewGoogleworkspaceProvider_Override

func NewGoogleworkspaceProvider_Override(g GoogleworkspaceProvider, scope constructs.Construct, id *string, config *GoogleworkspaceProviderConfig)

Create a new {@link https://www.terraform.io/docs/providers/googleworkspace googleworkspace} Resource.

Types

type GoogleworkspaceProvider

type GoogleworkspaceProvider interface {
	cdktf.TerraformProvider
	AccessToken() *string
	SetAccessToken(val *string)
	AccessTokenInput() *string
	Alias() *string
	SetAlias(val *string)
	AliasInput() *string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	Credentials() *string
	SetCredentials(val *string)
	CredentialsInput() *string
	CustomerId() *string
	SetCustomerId(val *string)
	CustomerIdInput() *string
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	ImpersonatedUserEmail() *string
	SetImpersonatedUserEmail(val *string)
	ImpersonatedUserEmailInput() *string
	// Experimental.
	MetaAttributes() *map[string]interface{}
	// The tree node.
	Node() constructs.Node
	OauthScopes() *[]*string
	SetOauthScopes(val *[]*string)
	OauthScopesInput() *[]*string
	// Experimental.
	RawOverrides() interface{}
	ServiceAccount() *string
	SetServiceAccount(val *string)
	ServiceAccountInput() *string
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformProviderSource() *string
	// Experimental.
	TerraformResourceType() *string
	// Experimental.
	AddOverride(path *string, value interface{})
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetAccessToken()
	ResetAlias()
	ResetCredentials()
	ResetCustomerId()
	ResetImpersonatedUserEmail()
	ResetOauthScopes()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetServiceAccount()
	SynthesizeAttributes() *map[string]interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

Represents a {@link https://www.terraform.io/docs/providers/googleworkspace googleworkspace}.

func NewGoogleworkspaceProvider

func NewGoogleworkspaceProvider(scope constructs.Construct, id *string, config *GoogleworkspaceProviderConfig) GoogleworkspaceProvider

Create a new {@link https://www.terraform.io/docs/providers/googleworkspace googleworkspace} Resource.

type GoogleworkspaceProviderConfig

type GoogleworkspaceProviderConfig struct {
	// A temporary [OAuth 2.0 access token] obtained from the Google Authorization server, i.e. the `Authorization: Bearer` token used to authenticate HTTP requests to Google Admin SDK APIs. This is an alternative to `credentials`, and ignores the `oauth_scopes` field. If both are specified, `access_token` will be used over the `credentials` field.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/googleworkspace#access_token GoogleworkspaceProvider#access_token}
	AccessToken *string `field:"optional" json:"accessToken" yaml:"accessToken"`
	// Alias name.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/googleworkspace#alias GoogleworkspaceProvider#alias}
	Alias *string `field:"optional" json:"alias" yaml:"alias"`
	// Either the path to or the contents of a service account key file in JSON format you can manage key files using the Cloud Console).
	//
	// If not provided, the application default credentials will be used.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/googleworkspace#credentials GoogleworkspaceProvider#credentials}
	Credentials *string `field:"optional" json:"credentials" yaml:"credentials"`
	// The customer id provided with your Google Workspace subscription. It is found in the admin console under Account Settings.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/googleworkspace#customer_id GoogleworkspaceProvider#customer_id}
	CustomerId *string `field:"optional" json:"customerId" yaml:"customerId"`
	// The impersonated user's email with access to the Admin APIs can access the Admin SDK Directory API.
	//
	// `impersonated_user_email` is required for all services except group and user management.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/googleworkspace#impersonated_user_email GoogleworkspaceProvider#impersonated_user_email}
	ImpersonatedUserEmail *string `field:"optional" json:"impersonatedUserEmail" yaml:"impersonatedUserEmail"`
	// The list of the scopes required for your application (for a list of possible scopes, see [Authorize requests](https://developers.google.com/admin-sdk/directory/v1/guides/authorizing)).
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/googleworkspace#oauth_scopes GoogleworkspaceProvider#oauth_scopes}
	OauthScopes *[]*string `field:"optional" json:"oauthScopes" yaml:"oauthScopes"`
	// The service account used to create the provided `access_token` if authenticating using the `access_token` method and needing to impersonate a user.
	//
	// This service account will require the GCP role `Service Account Token Creator` if needing to impersonate a user.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/googleworkspace#service_account GoogleworkspaceProvider#service_account}
	ServiceAccount *string `field:"optional" json:"serviceAccount" yaml:"serviceAccount"`
}