release

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_release

Refer to the Terraform Registory for docs: github_release.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewRelease_Override 

func NewRelease_Override(r Release, scope constructs.Construct, id *string, config *ReleaseConfig)

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

func Release_IsConstruct 

func Release_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 Release_IsTerraformElement 

func Release_IsTerraformElement(x interface{}) *bool

Experimental.

func Release_IsTerraformResource 

func Release_IsTerraformResource(x interface{}) *bool

Experimental.

func Release_TfResourceType 

func Release_TfResourceType() *string

Types

type Release 

type Release interface {
	cdktf.TerraformResource
	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)
	DiscussionCategoryName() *string
	SetDiscussionCategoryName(val *string)
	DiscussionCategoryNameInput() *string
	Draft() interface{}
	SetDraft(val interface{})
	DraftInput() interface{}
	Etag() *string
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	GenerateReleaseNotes() interface{}
	SetGenerateReleaseNotes(val interface{})
	GenerateReleaseNotesInput() interface{}
	Id() *string
	SetId(val *string)
	IdInput() *string
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	Name() *string
	SetName(val *string)
	NameInput() *string
	// The tree node.
	Node() constructs.Node
	Prerelease() interface{}
	SetPrerelease(val interface{})
	PrereleaseInput() interface{}
	// 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
	TagName() *string
	SetTagName(val *string)
	TagNameInput() *string
	TargetCommitish() *string
	SetTargetCommitish(val *string)
	TargetCommitishInput() *string
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	// 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()
	ResetDiscussionCategoryName()
	ResetDraft()
	ResetGenerateReleaseNotes()
	ResetId()
	ResetName()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetPrerelease()
	ResetTargetCommitish()
	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/release github_release}.

func NewRelease 

func NewRelease(scope constructs.Construct, id *string, config *ReleaseConfig) Release

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

type ReleaseConfig 

type ReleaseConfig 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 repository.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.26.0/docs/resources/release#repository Release#repository}
	Repository *string `field:"required" json:"repository" yaml:"repository"`
	// The name of the tag.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.26.0/docs/resources/release#tag_name Release#tag_name}
	TagName *string `field:"required" json:"tagName" yaml:"tagName"`
	// Text describing the contents of the tag.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.26.0/docs/resources/release#body Release#body}
	Body *string `field:"optional" json:"body" yaml:"body"`
	// If specified, a discussion of the specified category is created and linked to the release.
	//
	// The value must be a category that already exists in the repository.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.26.0/docs/resources/release#discussion_category_name Release#discussion_category_name}
	DiscussionCategoryName *string `field:"optional" json:"discussionCategoryName" yaml:"discussionCategoryName"`
	// Set to 'false' to create a published release.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.26.0/docs/resources/release#draft Release#draft}
	Draft interface{} `field:"optional" json:"draft" yaml:"draft"`
	// Set to 'true' to automatically generate the name and body for this release.
	//
	// If 'name' is specified, the specified name will be used; otherwise, a name will be automatically generated. If 'body' is specified, the body will be pre-pended to the automatically generated notes.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.26.0/docs/resources/release#generate_release_notes Release#generate_release_notes}
	GenerateReleaseNotes interface{} `field:"optional" json:"generateReleaseNotes" yaml:"generateReleaseNotes"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.26.0/docs/resources/release#id Release#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"`
	// The name of the release.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.26.0/docs/resources/release#name Release#name}
	Name *string `field:"optional" json:"name" yaml:"name"`
	// Set to 'false' to identify the release as a full release.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.26.0/docs/resources/release#prerelease Release#prerelease}
	Prerelease interface{} `field:"optional" json:"prerelease" yaml:"prerelease"`
	// The branch name or commit SHA the tag is created from.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.26.0/docs/resources/release#target_commitish Release#target_commitish}
	TargetCommitish *string `field:"optional" json:"targetCommitish" yaml:"targetCommitish"`
}

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.