repositoryenvironment

package
v8.0.5 Latest Latest
Warning

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

 Go to latest Published: Jun 2, 2023 License: MPL-2.0 Imports: 7 Imported by: 0

README

github_repository_environment

Refer to the Terraform Registory for docs: github_repository_environment.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewRepositoryEnvironmentDeploymentBranchPolicyOutputReference_Override 

func NewRepositoryEnvironmentDeploymentBranchPolicyOutputReference_Override(r RepositoryEnvironmentDeploymentBranchPolicyOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)

func NewRepositoryEnvironmentReviewersList_Override 

func NewRepositoryEnvironmentReviewersList_Override(r RepositoryEnvironmentReviewersList, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, wrapsSet *bool)

func NewRepositoryEnvironmentReviewersOutputReference_Override 

func NewRepositoryEnvironmentReviewersOutputReference_Override(r RepositoryEnvironmentReviewersOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, complexObjectIndex *float64, complexObjectIsFromSet *bool)

func NewRepositoryEnvironment_Override 

func NewRepositoryEnvironment_Override(r RepositoryEnvironment, scope constructs.Construct, id *string, config *RepositoryEnvironmentConfig)

Create a new {@link https://registry.terraform.io/providers/integrations/github/5.26.0/docs/resources/repository_environment github_repository_environment} Resource.

func RepositoryEnvironment_IsConstruct 

func RepositoryEnvironment_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 RepositoryEnvironment_IsTerraformElement 

func RepositoryEnvironment_IsTerraformElement(x interface{}) *bool

Experimental.

func RepositoryEnvironment_IsTerraformResource 

func RepositoryEnvironment_IsTerraformResource(x interface{}) *bool

Experimental.

func RepositoryEnvironment_TfResourceType 

func RepositoryEnvironment_TfResourceType() *string

Types

type RepositoryEnvironment 

type RepositoryEnvironment interface {
	cdktf.TerraformResource
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	Connection() interface{}
	// Experimental.
	SetConnection(val interface{})
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	DeploymentBranchPolicy() RepositoryEnvironmentDeploymentBranchPolicyOutputReference
	DeploymentBranchPolicyInput() *RepositoryEnvironmentDeploymentBranchPolicy
	Environment() *string
	SetEnvironment(val *string)
	EnvironmentInput() *string
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	Id() *string
	SetId(val *string)
	IdInput() *string
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	// The tree node.
	Node() constructs.Node
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	Provisioners() *[]interface{}
	// Experimental.
	SetProvisioners(val *[]interface{})
	// Experimental.
	RawOverrides() interface{}
	Repository() *string
	SetRepository(val *string)
	RepositoryInput() *string
	Reviewers() RepositoryEnvironmentReviewersList
	ReviewersInput() interface{}
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	WaitTimer() *float64
	SetWaitTimer(val *float64)
	WaitTimerInput() *float64
	// Experimental.
	AddOverride(path *string, value interface{})
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	PutDeploymentBranchPolicy(value *RepositoryEnvironmentDeploymentBranchPolicy)
	PutReviewers(value interface{})
	ResetDeploymentBranchPolicy()
	ResetId()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetReviewers()
	ResetWaitTimer()
	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://registry.terraform.io/providers/integrations/github/5.26.0/docs/resources/repository_environment github_repository_environment}.

func NewRepositoryEnvironment 

func NewRepositoryEnvironment(scope constructs.Construct, id *string, config *RepositoryEnvironmentConfig) RepositoryEnvironment

Create a new {@link https://registry.terraform.io/providers/integrations/github/5.26.0/docs/resources/repository_environment github_repository_environment} Resource.

type RepositoryEnvironmentConfig 

type RepositoryEnvironmentConfig struct {
	// Experimental.
	Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
	// Experimental.
	Count interface{} `field:"optional" json:"count" yaml:"count"`
	// Experimental.
	DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
	// Experimental.
	ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
	// Experimental.
	Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
	// Experimental.
	Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
	// Experimental.
	Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
	// The name of the environment.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.26.0/docs/resources/repository_environment#environment RepositoryEnvironment#environment}
	Environment *string `field:"required" json:"environment" yaml:"environment"`
	// The repository of the environment.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.26.0/docs/resources/repository_environment#repository RepositoryEnvironment#repository}
	Repository *string `field:"required" json:"repository" yaml:"repository"`
	// deployment_branch_policy block.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.26.0/docs/resources/repository_environment#deployment_branch_policy RepositoryEnvironment#deployment_branch_policy}
	DeploymentBranchPolicy *RepositoryEnvironmentDeploymentBranchPolicy `field:"optional" json:"deploymentBranchPolicy" yaml:"deploymentBranchPolicy"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.26.0/docs/resources/repository_environment#id RepositoryEnvironment#id}.
	//
	// Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2.
	// If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
	Id *string `field:"optional" json:"id" yaml:"id"`
	// reviewers block.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.26.0/docs/resources/repository_environment#reviewers RepositoryEnvironment#reviewers}
	Reviewers interface{} `field:"optional" json:"reviewers" yaml:"reviewers"`
	// Amount of time to delay a job after the job is initially triggered.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.26.0/docs/resources/repository_environment#wait_timer RepositoryEnvironment#wait_timer}
	WaitTimer *float64 `field:"optional" json:"waitTimer" yaml:"waitTimer"`
}

type RepositoryEnvironmentDeploymentBranchPolicy 

type RepositoryEnvironmentDeploymentBranchPolicy struct {
	// Whether only branches that match the specified name patterns can deploy to this environment.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.26.0/docs/resources/repository_environment#custom_branch_policies RepositoryEnvironment#custom_branch_policies}
	CustomBranchPolicies interface{} `field:"required" json:"customBranchPolicies" yaml:"customBranchPolicies"`
	// Whether only branches with branch protection rules can deploy to this environment.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.26.0/docs/resources/repository_environment#protected_branches RepositoryEnvironment#protected_branches}
	ProtectedBranches interface{} `field:"required" json:"protectedBranches" yaml:"protectedBranches"`
}

type RepositoryEnvironmentDeploymentBranchPolicyOutputReference 

type RepositoryEnvironmentDeploymentBranchPolicyOutputReference interface {
	cdktf.ComplexObject
	// the index of the complex object in a list.
	// Experimental.
	ComplexObjectIndex() interface{}
	// Experimental.
	SetComplexObjectIndex(val interface{})
	// set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
	// Experimental.
	ComplexObjectIsFromSet() *bool
	// Experimental.
	SetComplexObjectIsFromSet(val *bool)
	// 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.
	// Experimental.
	CreationStack() *[]*string
	CustomBranchPolicies() interface{}
	SetCustomBranchPolicies(val interface{})
	CustomBranchPoliciesInput() interface{}
	// Experimental.
	Fqn() *string
	InternalValue() *RepositoryEnvironmentDeploymentBranchPolicy
	SetInternalValue(val *RepositoryEnvironmentDeploymentBranchPolicy)
	ProtectedBranches() interface{}
	SetProtectedBranches(val interface{})
	ProtectedBranchesInput() interface{}
	// Experimental.
	TerraformAttribute() *string
	// Experimental.
	SetTerraformAttribute(val *string)
	// Experimental.
	TerraformResource() cdktf.IInterpolatingParent
	// Experimental.
	SetTerraformResource(val cdktf.IInterpolatingParent)
	// Experimental.
	ComputeFqn() *string
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationAsList() cdktf.IResolvable
	// Experimental.
	InterpolationForAttribute(property *string) cdktf.IResolvable
	// Produce the Token's value at resolution time.
	// Experimental.
	Resolve(_context cdktf.IResolveContext) interface{}
	// Return a string representation of this resolvable object.
	//
	// Returns a reversible string representation.
	// Experimental.
	ToString() *string
}

func NewRepositoryEnvironmentDeploymentBranchPolicyOutputReference 

func NewRepositoryEnvironmentDeploymentBranchPolicyOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) RepositoryEnvironmentDeploymentBranchPolicyOutputReference

type RepositoryEnvironmentReviewers 

type RepositoryEnvironmentReviewers struct {
	// Up to 6 IDs for teams who may review jobs that reference the environment.
	//
	// Reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.26.0/docs/resources/repository_environment#teams RepositoryEnvironment#teams}
	Teams *[]*float64 `field:"optional" json:"teams" yaml:"teams"`
	// Up to 6 IDs for users who may review jobs that reference the environment.
	//
	// Reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.26.0/docs/resources/repository_environment#users RepositoryEnvironment#users}
	Users *[]*float64 `field:"optional" json:"users" yaml:"users"`
}

type RepositoryEnvironmentReviewersList 

type RepositoryEnvironmentReviewersList interface {
	cdktf.ComplexList
	// 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.
	// Experimental.
	CreationStack() *[]*string
	// Experimental.
	Fqn() *string
	InternalValue() interface{}
	SetInternalValue(val interface{})
	// The attribute on the parent resource this class is referencing.
	TerraformAttribute() *string
	SetTerraformAttribute(val *string)
	// The parent resource.
	TerraformResource() cdktf.IInterpolatingParent
	SetTerraformResource(val cdktf.IInterpolatingParent)
	// whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
	WrapsSet() *bool
	SetWrapsSet(val *bool)
	// Experimental.
	ComputeFqn() *string
	Get(index *float64) RepositoryEnvironmentReviewersOutputReference
	// Produce the Token's value at resolution time.
	// Experimental.
	Resolve(_context cdktf.IResolveContext) interface{}
	// Return a string representation of this resolvable object.
	//
	// Returns a reversible string representation.
	// Experimental.
	ToString() *string
}

func NewRepositoryEnvironmentReviewersList 

func NewRepositoryEnvironmentReviewersList(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) RepositoryEnvironmentReviewersList

type RepositoryEnvironmentReviewersOutputReference 

type RepositoryEnvironmentReviewersOutputReference interface {
	cdktf.ComplexObject
	// the index of the complex object in a list.
	// Experimental.
	ComplexObjectIndex() interface{}
	// Experimental.
	SetComplexObjectIndex(val interface{})
	// set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
	// Experimental.
	ComplexObjectIsFromSet() *bool
	// Experimental.
	SetComplexObjectIsFromSet(val *bool)
	// 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.
	// Experimental.
	CreationStack() *[]*string
	// Experimental.
	Fqn() *string
	InternalValue() interface{}
	SetInternalValue(val interface{})
	Teams() *[]*float64
	SetTeams(val *[]*float64)
	TeamsInput() *[]*float64
	// Experimental.
	TerraformAttribute() *string
	// Experimental.
	SetTerraformAttribute(val *string)
	// Experimental.
	TerraformResource() cdktf.IInterpolatingParent
	// Experimental.
	SetTerraformResource(val cdktf.IInterpolatingParent)
	Users() *[]*float64
	SetUsers(val *[]*float64)
	UsersInput() *[]*float64
	// Experimental.
	ComputeFqn() *string
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationAsList() cdktf.IResolvable
	// Experimental.
	InterpolationForAttribute(property *string) cdktf.IResolvable
	ResetTeams()
	ResetUsers()
	// Produce the Token's value at resolution time.
	// Experimental.
	Resolve(_context cdktf.IResolveContext) interface{}
	// Return a string representation of this resolvable object.
	//
	// Returns a reversible string representation.
	// Experimental.
	ToString() *string
}

func NewRepositoryEnvironmentReviewersOutputReference 

func NewRepositoryEnvironmentReviewersOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, complexObjectIndex *float64, complexObjectIsFromSet *bool) RepositoryEnvironmentReviewersOutputReference

Source Files

View all Source files

Directories

Path Synopsis

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.