Skip to content

Latest commit

 

History

History
1446 lines (895 loc) · 61.5 KB

projectAccessToken.go.md

File metadata and controls

1446 lines (895 loc) · 61.5 KB

projectAccessToken Submodule

Constructs

ProjectAccessToken

Represents a {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/project_access_token gitlab_project_access_token}.

Initializers

import "github.com/cdktf/cdktf-provider-gitlab-go/gitlab/v13/projectaccesstoken"

projectaccesstoken.NewProjectAccessToken(scope Construct, id *string, config ProjectAccessTokenConfig) ProjectAccessToken
Name Type Description
scope github.com/aws/constructs-go/constructs/v10.Construct The scope in which to define this construct.
id *string The scoped construct ID.
config ProjectAccessTokenConfig No description.

scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.


idRequired
  • Type: *string

The scoped construct ID.

Must be unique amongst siblings in the same scope


configRequired

Methods

Name Description
ToString Returns a string representation of this construct.
AddOverride No description.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
ResetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform No description.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
AddMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
HasResourceMove No description.
ImportFrom No description.
InterpolationForAttribute No description.
MoveFromId Move the resource corresponding to "id" to this resource.
MoveTo Moves this resource to the target resource given by moveTarget.
MoveToId Moves this resource to the resource corresponding to "id".
PutRotationConfiguration No description.
ResetAccessLevel No description.
ResetExpiresAt No description.
ResetRotationConfiguration No description.

ToString
func ToString() *string

Returns a string representation of this construct.

AddOverride
func AddOverride(path *string, value interface{})
pathRequired
  • Type: *string

valueRequired
  • Type: interface{}

OverrideLogicalId
func OverrideLogicalId(newLogicalId *string)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: *string

The new logical ID to use for this stack element.


ResetOverrideLogicalId
func ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

ToHclTerraform
func ToHclTerraform() interface{}
ToMetadata
func ToMetadata() interface{}
ToTerraform
func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

AddMoveTarget
func AddMoveTarget(moveTarget *string)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: *string

The string move target that will correspond to this resource.


GetAnyMapAttribute
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string

GetBooleanAttribute
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string

GetBooleanMapAttribute
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string

GetListAttribute
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string

GetNumberAttribute
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string

GetNumberListAttribute
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string

GetNumberMapAttribute
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string

GetStringAttribute
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string

GetStringMapAttribute
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string

HasResourceMove
func HasResourceMove() interface{}
ImportFrom
func ImportFrom(id *string, provider TerraformProvider)
idRequired
  • Type: *string

providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

InterpolationForAttribute
func InterpolationForAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string

MoveFromId
func MoveFromId(id *string)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: *string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".


MoveTo
func MoveTo(moveTarget *string, index interface{})

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: *string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.


indexOptional
  • Type: interface{}

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.


MoveToId
func MoveToId(id *string)

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: *string

Full id of resource to move to, e.g. "aws_s3_bucket.example".


PutRotationConfiguration
func PutRotationConfiguration(value ProjectAccessTokenRotationConfiguration)
valueRequired

ResetAccessLevel
func ResetAccessLevel()
ResetExpiresAt
func ResetExpiresAt()
ResetRotationConfiguration
func ResetRotationConfiguration()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTF code for importing a ProjectAccessToken resource upon running "cdktf plan ".

IsConstruct
import "github.com/cdktf/cdktf-provider-gitlab-go/gitlab/v13/projectaccesstoken"

projectaccesstoken.ProjectAccessToken_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.

xRequired
  • Type: interface{}

Any object.


IsTerraformElement
import "github.com/cdktf/cdktf-provider-gitlab-go/gitlab/v13/projectaccesstoken"

projectaccesstoken.ProjectAccessToken_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}

IsTerraformResource
import "github.com/cdktf/cdktf-provider-gitlab-go/gitlab/v13/projectaccesstoken"

projectaccesstoken.ProjectAccessToken_IsTerraformResource(x interface{}) *bool
xRequired
  • Type: interface{}

GenerateConfigForImport
import "github.com/cdktf/cdktf-provider-gitlab-go/gitlab/v13/projectaccesstoken"

projectaccesstoken.ProjectAccessToken_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

Generates CDKTF code for importing a ProjectAccessToken resource upon running "cdktf plan ".

scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: *string

The construct id used in the generated config for the ProjectAccessToken to import.


importFromIdRequired
  • Type: *string

The id of the existing ProjectAccessToken that should be imported.

Refer to the {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/project_access_token#import import section} in the documentation of this resource for the id to use


providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

? Optional instance of the provider where the ProjectAccessToken to import is found.


Properties

Name Type Description
Node github.com/aws/constructs-go/constructs/v10.Node The tree node.
CdktfStack github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack No description.
Fqn *string No description.
FriendlyUniqueId *string No description.
TerraformMetaArguments *map[string]interface{} No description.
TerraformResourceType *string No description.
TerraformGeneratorMetadata github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata No description.
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]*string No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
Active github.com/hashicorp/terraform-cdk-go/cdktf.IResolvable No description.
CreatedAt *string No description.
Id *string No description.
Revoked github.com/hashicorp/terraform-cdk-go/cdktf.IResolvable No description.
RotationConfiguration ProjectAccessTokenRotationConfigurationOutputReference No description.
Token *string No description.
UserId *f64 No description.
AccessLevelInput *string No description.
ExpiresAtInput *string No description.
NameInput *string No description.
ProjectInput *string No description.
RotationConfigurationInput interface{} No description.
ScopesInput *[]*string No description.
AccessLevel *string No description.
ExpiresAt *string No description.
Name *string No description.
Project *string No description.
Scopes *[]*string No description.

NodeRequired
func Node() Node
  • Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.


CdktfStackRequired
func CdktfStack() TerraformStack
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack

FqnRequired
func Fqn() *string
  • Type: *string

FriendlyUniqueIdRequired
func FriendlyUniqueId() *string
  • Type: *string

TerraformMetaArgumentsRequired
func TerraformMetaArguments() *map[string]interface{}
  • Type: *map[string]interface{}

TerraformResourceTypeRequired
func TerraformResourceType() *string
  • Type: *string

TerraformGeneratorMetadataOptional
func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata

ConnectionOptional
func Connection() interface{}
  • Type: interface{}

CountOptional
func Count() interface{}
  • Type: interface{}

DependsOnOptional
func DependsOn() *[]*string
  • Type: *[]*string

ForEachOptional
func ForEach() ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

LifecycleOptional
func Lifecycle() TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

ProviderOptional
func Provider() TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

ProvisionersOptional
func Provisioners() *[]interface{}
  • Type: *[]interface{}

ActiveRequired
func Active() IResolvable
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolvable

CreatedAtRequired
func CreatedAt() *string
  • Type: *string

IdRequired
func Id() *string
  • Type: *string

RevokedRequired
func Revoked() IResolvable
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolvable

RotationConfigurationRequired
func RotationConfiguration() ProjectAccessTokenRotationConfigurationOutputReference

TokenRequired
func Token() *string
  • Type: *string

UserIdRequired
func UserId() *f64
  • Type: *f64

AccessLevelInputOptional
func AccessLevelInput() *string
  • Type: *string

ExpiresAtInputOptional
func ExpiresAtInput() *string
  • Type: *string

NameInputOptional
func NameInput() *string
  • Type: *string

ProjectInputOptional
func ProjectInput() *string
  • Type: *string

RotationConfigurationInputOptional
func RotationConfigurationInput() interface{}
  • Type: interface{}

ScopesInputOptional
func ScopesInput() *[]*string
  • Type: *[]*string

AccessLevelRequired
func AccessLevel() *string
  • Type: *string

ExpiresAtRequired
func ExpiresAt() *string
  • Type: *string

NameRequired
func Name() *string
  • Type: *string

ProjectRequired
func Project() *string
  • Type: *string

ScopesRequired
func Scopes() *[]*string
  • Type: *[]*string

Constants

Name Type Description
TfResourceType *string No description.

TfResourceTypeRequired
func TfResourceType() *string
  • Type: *string

Structs

ProjectAccessTokenConfig

Initializer

import "github.com/cdktf/cdktf-provider-gitlab-go/gitlab/v13/projectaccesstoken"

&projectaccesstoken.ProjectAccessTokenConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	Name: *string,
	Project: *string,
	Scopes: *[]*string,
	AccessLevel: *string,
	ExpiresAt: *string,
	RotationConfiguration: github.com/cdktf/cdktf-provider-gitlab-go/gitlab/v13.projectAccessToken.ProjectAccessTokenRotationConfiguration,
}

Properties

Name Type Description
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
Name *string The name of the project access token.
Project *string The ID or full path of the project.
Scopes *[]*string The scopes of the project access token.
AccessLevel *string The access level for the project access token.
ExpiresAt *string When the token will expire, YYYY-MM-DD format. Is automatically set when rotation_configuration is used.
RotationConfiguration ProjectAccessTokenRotationConfiguration The configuration for when to rotate a token automatically. Will not rotate a token until terraform apply is run.

ConnectionOptional
Connection interface{}
  • Type: interface{}

CountOptional
Count interface{}
  • Type: interface{}

DependsOnOptional
DependsOn *[]ITerraformDependable
  • Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable

ForEachOptional
ForEach ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

LifecycleOptional
Lifecycle TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

ProviderOptional
Provider TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

ProvisionersOptional
Provisioners *[]interface{}
  • Type: *[]interface{}

NameRequired
Name *string
  • Type: *string

The name of the project access token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/project_access_token#name ProjectAccessToken#name}


ProjectRequired
Project *string
  • Type: *string

The ID or full path of the project.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/project_access_token#project ProjectAccessToken#project}


ScopesRequired
Scopes *[]*string
  • Type: *[]*string

The scopes of the project access token.

valid values are: api, read_api, read_registry, write_registry, read_repository, write_repository, create_runner, manage_runner, ai_features, k8s_proxy, read_observability, write_observability

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/project_access_token#scopes ProjectAccessToken#scopes}


AccessLevelOptional
AccessLevel *string
  • Type: *string

The access level for the project access token.

Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner. Default is maintainer.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/project_access_token#access_level ProjectAccessToken#access_level}


ExpiresAtOptional
ExpiresAt *string
  • Type: *string

When the token will expire, YYYY-MM-DD format. Is automatically set when rotation_configuration is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/project_access_token#expires_at ProjectAccessToken#expires_at}


RotationConfigurationOptional
RotationConfiguration ProjectAccessTokenRotationConfiguration

The configuration for when to rotate a token automatically. Will not rotate a token until terraform apply is run.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/project_access_token#rotation_configuration ProjectAccessToken#rotation_configuration}


ProjectAccessTokenRotationConfiguration

Initializer

import "github.com/cdktf/cdktf-provider-gitlab-go/gitlab/v13/projectaccesstoken"

&projectaccesstoken.ProjectAccessTokenRotationConfiguration {
	ExpirationDays: *f64,
	RotateBeforeDays: *f64,
}

Properties

Name Type Description
ExpirationDays *f64 The duration (in days) the new token should be valid for.
RotateBeforeDays *f64 The duration (in days) before the expiration when the token should be rotated.

ExpirationDaysRequired
ExpirationDays *f64
  • Type: *f64

The duration (in days) the new token should be valid for.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/project_access_token#expiration_days ProjectAccessToken#expiration_days}


RotateBeforeDaysRequired
RotateBeforeDays *f64
  • Type: *f64

The duration (in days) before the expiration when the token should be rotated.

As an example, if set to 7 days, the token will rotate 7 days before the expiration date, but only when terraform apply is run in that timeframe.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/project_access_token#rotate_before_days ProjectAccessToken#rotate_before_days}


Classes

ProjectAccessTokenRotationConfigurationOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-gitlab-go/gitlab/v13/projectaccesstoken"

projectaccesstoken.NewProjectAccessTokenRotationConfigurationOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) ProjectAccessTokenRotationConfigurationOutputReference
Name Type Description
terraformResource github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent The parent resource.
terraformAttribute *string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: *string

The attribute on the parent resource this class is referencing.


Methods

Name Description
ComputeFqn No description.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
InterpolationForAttribute No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.

ComputeFqn
func ComputeFqn() *string
GetAnyMapAttribute
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string

GetBooleanAttribute
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string

GetBooleanMapAttribute
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string

GetListAttribute
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string

GetNumberAttribute
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string

GetNumberListAttribute
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string

GetNumberMapAttribute
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string

GetStringAttribute
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string

GetStringMapAttribute
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string

InterpolationForAttribute
func InterpolationForAttribute(property *string) IResolvable
propertyRequired
  • Type: *string

Resolve
func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_contextRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

ToString
func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
CreationStack *[]*string The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn *string No description.
ExpirationDaysInput *f64 No description.
RotateBeforeDaysInput *f64 No description.
ExpirationDays *f64 No description.
RotateBeforeDays *f64 No description.
InternalValue interface{} No description.

CreationStackRequired
func CreationStack() *[]*string
  • Type: *[]*string

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


FqnRequired
func Fqn() *string
  • Type: *string

ExpirationDaysInputOptional
func ExpirationDaysInput() *f64
  • Type: *f64

RotateBeforeDaysInputOptional
func RotateBeforeDaysInput() *f64
  • Type: *f64

ExpirationDaysRequired
func ExpirationDays() *f64
  • Type: *f64

RotateBeforeDaysRequired
func RotateBeforeDays() *f64
  • Type: *f64

InternalValueOptional
func InternalValue() interface{}
  • Type: interface{}