repositorypullrequest

README

github_repository_pull_request

Refer to the Terraform Registory for docs: github_repository_pull_request.

Documentation

Index

• func NewRepositoryPullRequest_Override(r RepositoryPullRequest, scope constructs.Construct, id *string, ...)
• func RepositoryPullRequest_IsConstruct(x interface{}) *bool
• func RepositoryPullRequest_IsTerraformElement(x interface{}) *bool
• func RepositoryPullRequest_IsTerraformResource(x interface{}) *bool
• func RepositoryPullRequest_TfResourceType() *string
• type RepositoryPullRequest
  • func NewRepositoryPullRequest(scope constructs.Construct, id *string, config *RepositoryPullRequestConfig) RepositoryPullRequest
• type RepositoryPullRequestConfig

Functions

func NewRepositoryPullRequest_Override

func NewRepositoryPullRequest_Override(r RepositoryPullRequest, scope constructs.Construct, id *string, config *RepositoryPullRequestConfig)

Create a new {@link https://registry.terraform.io/providers/integrations/github/5.23.0/docs/resources/repository_pull_request github_repository_pull_request} Resource.

func RepositoryPullRequest_IsConstruct

func RepositoryPullRequest_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 RepositoryPullRequest_IsTerraformElement

func RepositoryPullRequest_IsTerraformElement(x interface{}) *bool

Experimental.

func RepositoryPullRequest_IsTerraformResource

func RepositoryPullRequest_IsTerraformResource(x interface{}) *bool

Experimental.

func RepositoryPullRequest_TfResourceType

func RepositoryPullRequest_TfResourceType() *string

Types

type RepositoryPullRequest

type RepositoryPullRequest interface {
	cdktf.TerraformResource
	BaseRef() *string
	SetBaseRef(val *string)
	BaseRefInput() *string
	BaseRepository() *string
	SetBaseRepository(val *string)
	BaseRepositoryInput() *string
	BaseSha() *string
	Body() *string
	SetBody(val *string)
	BodyInput() *string
	// 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)
	Draft() cdktf.IResolvable
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	HeadRef() *string
	SetHeadRef(val *string)
	HeadRefInput() *string
	HeadSha() *string
	Id() *string
	SetId(val *string)
	IdInput() *string
	Labels() *[]*string
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	MaintainerCanModify() interface{}
	SetMaintainerCanModify(val interface{})
	MaintainerCanModifyInput() interface{}
	// The tree node.
	Node() constructs.Node
	Number() *float64
	OpenedAt() *float64
	OpenedBy() *string
	Owner() *string
	SetOwner(val *string)
	OwnerInput() *string
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	Provisioners() *[]interface{}
	// Experimental.
	SetProvisioners(val *[]interface{})
	// Experimental.
	RawOverrides() interface{}
	State() *string
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	Title() *string
	SetTitle(val *string)
	TitleInput() *string
	UpdatedAt() *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)
	ResetBody()
	ResetId()
	ResetMaintainerCanModify()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetOwner()
	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.23.0/docs/resources/repository_pull_request github_repository_pull_request}.

func NewRepositoryPullRequest

func NewRepositoryPullRequest(scope constructs.Construct, id *string, config *RepositoryPullRequestConfig) RepositoryPullRequest

Create a new {@link https://registry.terraform.io/providers/integrations/github/5.23.0/docs/resources/repository_pull_request github_repository_pull_request} Resource.

type RepositoryPullRequestConfig

type RepositoryPullRequestConfig 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"`
	// Name of the branch serving as the base of the Pull Request.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.23.0/docs/resources/repository_pull_request#base_ref RepositoryPullRequest#base_ref}
	BaseRef *string `field:"required" json:"baseRef" yaml:"baseRef"`
	// Name of the base repository to retrieve the Pull Requests from.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.23.0/docs/resources/repository_pull_request#base_repository RepositoryPullRequest#base_repository}
	BaseRepository *string `field:"required" json:"baseRepository" yaml:"baseRepository"`
	// Name of the branch serving as the head of the Pull Request.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.23.0/docs/resources/repository_pull_request#head_ref RepositoryPullRequest#head_ref}
	HeadRef *string `field:"required" json:"headRef" yaml:"headRef"`
	// The title of the Pull Request.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.23.0/docs/resources/repository_pull_request#title RepositoryPullRequest#title}
	Title *string `field:"required" json:"title" yaml:"title"`
	// Body of the Pull Request.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.23.0/docs/resources/repository_pull_request#body RepositoryPullRequest#body}
	Body *string `field:"optional" json:"body" yaml:"body"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.23.0/docs/resources/repository_pull_request#id RepositoryPullRequest#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"`
	// Controls whether the base repository maintainers can modify the Pull Request. Default: 'false'.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.23.0/docs/resources/repository_pull_request#maintainer_can_modify RepositoryPullRequest#maintainer_can_modify}
	MaintainerCanModify interface{} `field:"optional" json:"maintainerCanModify" yaml:"maintainerCanModify"`
	// Owner of the repository. If not provided, the provider's default owner is used.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.23.0/docs/resources/repository_pull_request#owner RepositoryPullRequest#owner}
	Owner *string `field:"optional" json:"owner" yaml:"owner"`
}