Skip to content

Latest commit

 

History

History
1521 lines (953 loc) · 61.1 KB

release.java.md

File metadata and controls

1521 lines (953 loc) · 61.1 KB

release Submodule

Constructs

Release

Represents a {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/release github_release}.

Initializers

import com.hashicorp.cdktf.providers.github.release.Release;

Release.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .repository(java.lang.String)
    .tagName(java.lang.String)
//  .body(java.lang.String)
//  .discussionCategoryName(java.lang.String)
//  .draft(java.lang.Boolean)
//  .draft(IResolvable)
//  .generateReleaseNotes(java.lang.Boolean)
//  .generateReleaseNotes(IResolvable)
//  .id(java.lang.String)
//  .name(java.lang.String)
//  .prerelease(java.lang.Boolean)
//  .prerelease(IResolvable)
//  .targetCommitish(java.lang.String)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
repository java.lang.String The name of the repository.
tagName java.lang.String The name of the tag.
body java.lang.String Text describing the contents of the tag.
discussionCategoryName java.lang.String If specified, a discussion of the specified category is created and linked to the release.
draft java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Set to 'false' to create a published release.
generateReleaseNotes java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Set to 'true' to automatically generate the name and body for this release.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/release#id Release#id}.
name java.lang.String The name of the release.
prerelease java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Set to 'false' to identify the release as a full release.
targetCommitish java.lang.String The branch name or commit SHA the tag is created from.

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope


connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>

forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

repositoryRequired
  • Type: java.lang.String

The name of the repository.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/release#repository Release#repository}


tagNameRequired
  • Type: java.lang.String

The name of the tag.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/release#tag_name Release#tag_name}


bodyOptional
  • Type: java.lang.String

Text describing the contents of the tag.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/release#body Release#body}


discussionCategoryNameOptional
  • Type: java.lang.String

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/6.2.3/docs/resources/release#discussion_category_name Release#discussion_category_name}


draftOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Set to 'false' to create a published release.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/release#draft Release#draft}


generateReleaseNotesOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

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/6.2.3/docs/resources/release#generate_release_notes Release#generate_release_notes}


idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/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.


nameOptional
  • Type: java.lang.String

The name of the release.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/release#name Release#name}


prereleaseOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Set to 'false' to identify the release as a full release.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/release#prerelease Release#prerelease}


targetCommitishOptional
  • Type: java.lang.String

The branch name or commit SHA the tag is created from.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/release#target_commitish Release#target_commitish}


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".
resetBody No description.
resetDiscussionCategoryName No description.
resetDraft No description.
resetGenerateReleaseNotes No description.
resetId No description.
resetName No description.
resetPrerelease No description.
resetTargetCommitish No description.

toString
public java.lang.String toString()

Returns a string representation of this construct.

addOverride
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String

valueRequired
  • Type: java.lang.Object

overrideLogicalId
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.


resetOverrideLogicalId
public void resetOverrideLogicalId()

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

toHclTerraform
public java.lang.Object toHclTerraform()
toMetadata
public java.lang.Object toMetadata()
toTerraform
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget
public void addMoveTarget(java.lang.String moveTarget)

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: java.lang.String

The string move target that will correspond to this resource.


getAnyMapAttribute
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanAttribute
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanMapAttribute
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getListAttribute
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberAttribute
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberListAttribute
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberMapAttribute
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringAttribute
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringMapAttribute
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

hasResourceMove
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

interpolationForAttribute
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

moveFromId
public void moveFromId(java.lang.String id)

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: java.lang.String

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


moveTo
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

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


indexOptional
  • Type: java.lang.String OR java.lang.Number

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


moveToId
public void moveToId(java.lang.String id)

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

idRequired
  • Type: java.lang.String

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


resetBody
public void resetBody()
resetDiscussionCategoryName
public void resetDiscussionCategoryName()
resetDraft
public void resetDraft()
resetGenerateReleaseNotes
public void resetGenerateReleaseNotes()
resetId
public void resetId()
resetName
public void resetName()
resetPrerelease
public void resetPrerelease()
resetTargetCommitish
public void resetTargetCommitish()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a Release resource upon running "cdktf plan ".

isConstruct
import com.hashicorp.cdktf.providers.github.release.Release;

Release.isConstruct(java.lang.Object x)

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: java.lang.Object

Any object.


isTerraformElement
import com.hashicorp.cdktf.providers.github.release.Release;

Release.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object

isTerraformResource
import com.hashicorp.cdktf.providers.github.release.Release;

Release.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object

generateConfigForImport
import com.hashicorp.cdktf.providers.github.release.Release;

Release.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),Release.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

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

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: java.lang.String

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


importFromIdRequired
  • Type: java.lang.String

The id of the existing Release that should be imported.

Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/release#import import section} in the documentation of this resource for the id to use


providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

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


Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
assetsUrl java.lang.String No description.
createdAt java.lang.String No description.
etag java.lang.String No description.
htmlUrl java.lang.String No description.
nodeId java.lang.String No description.
publishedAt java.lang.String No description.
releaseId java.lang.Number No description.
tarballUrl java.lang.String No description.
uploadUrl java.lang.String No description.
url java.lang.String No description.
zipballUrl java.lang.String No description.
bodyInput java.lang.String No description.
discussionCategoryNameInput java.lang.String No description.
draftInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
generateReleaseNotesInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
idInput java.lang.String No description.
nameInput java.lang.String No description.
prereleaseInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
repositoryInput java.lang.String No description.
tagNameInput java.lang.String No description.
targetCommitishInput java.lang.String No description.
body java.lang.String No description.
discussionCategoryName java.lang.String No description.
draft java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
generateReleaseNotes java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
id java.lang.String No description.
name java.lang.String No description.
prerelease java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
repository java.lang.String No description.
tagName java.lang.String No description.
targetCommitish java.lang.String No description.

nodeRequired
public Node getNode();
  • Type: software.constructs.Node

The tree node.


cdktfStackRequired
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack

fqnRequired
public java.lang.String getFqn();
  • Type: java.lang.String

friendlyUniqueIdRequired
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String

terraformMetaArgumentsRequired
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>

terraformResourceTypeRequired
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String

terraformGeneratorMetadataOptional
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata

connectionOptional
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>

forEachOptional
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider

provisionersOptional
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

assetsUrlRequired
public java.lang.String getAssetsUrl();
  • Type: java.lang.String

createdAtRequired
public java.lang.String getCreatedAt();
  • Type: java.lang.String

etagRequired
public java.lang.String getEtag();
  • Type: java.lang.String

htmlUrlRequired
public java.lang.String getHtmlUrl();
  • Type: java.lang.String

nodeIdRequired
public java.lang.String getNodeId();
  • Type: java.lang.String

publishedAtRequired
public java.lang.String getPublishedAt();
  • Type: java.lang.String

releaseIdRequired
public java.lang.Number getReleaseId();
  • Type: java.lang.Number

tarballUrlRequired
public java.lang.String getTarballUrl();
  • Type: java.lang.String

uploadUrlRequired
public java.lang.String getUploadUrl();
  • Type: java.lang.String

urlRequired
public java.lang.String getUrl();
  • Type: java.lang.String

zipballUrlRequired
public java.lang.String getZipballUrl();
  • Type: java.lang.String

bodyInputOptional
public java.lang.String getBodyInput();
  • Type: java.lang.String

discussionCategoryNameInputOptional
public java.lang.String getDiscussionCategoryNameInput();
  • Type: java.lang.String

draftInputOptional
public java.lang.Object getDraftInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

generateReleaseNotesInputOptional
public java.lang.Object getGenerateReleaseNotesInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

idInputOptional
public java.lang.String getIdInput();
  • Type: java.lang.String

nameInputOptional
public java.lang.String getNameInput();
  • Type: java.lang.String

prereleaseInputOptional
public java.lang.Object getPrereleaseInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

repositoryInputOptional
public java.lang.String getRepositoryInput();
  • Type: java.lang.String

tagNameInputOptional
public java.lang.String getTagNameInput();
  • Type: java.lang.String

targetCommitishInputOptional
public java.lang.String getTargetCommitishInput();
  • Type: java.lang.String

bodyRequired
public java.lang.String getBody();
  • Type: java.lang.String

discussionCategoryNameRequired
public java.lang.String getDiscussionCategoryName();
  • Type: java.lang.String

draftRequired
public java.lang.Object getDraft();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

generateReleaseNotesRequired
public java.lang.Object getGenerateReleaseNotes();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

idRequired
public java.lang.String getId();
  • Type: java.lang.String

nameRequired
public java.lang.String getName();
  • Type: java.lang.String

prereleaseRequired
public java.lang.Object getPrerelease();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

repositoryRequired
public java.lang.String getRepository();
  • Type: java.lang.String

tagNameRequired
public java.lang.String getTagName();
  • Type: java.lang.String

targetCommitishRequired
public java.lang.String getTargetCommitish();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.

tfResourceTypeRequired
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

ReleaseConfig

Initializer

import com.hashicorp.cdktf.providers.github.release.ReleaseConfig;

ReleaseConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .repository(java.lang.String)
    .tagName(java.lang.String)
//  .body(java.lang.String)
//  .discussionCategoryName(java.lang.String)
//  .draft(java.lang.Boolean)
//  .draft(IResolvable)
//  .generateReleaseNotes(java.lang.Boolean)
//  .generateReleaseNotes(IResolvable)
//  .id(java.lang.String)
//  .name(java.lang.String)
//  .prerelease(java.lang.Boolean)
//  .prerelease(IResolvable)
//  .targetCommitish(java.lang.String)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
repository java.lang.String The name of the repository.
tagName java.lang.String The name of the tag.
body java.lang.String Text describing the contents of the tag.
discussionCategoryName java.lang.String If specified, a discussion of the specified category is created and linked to the release.
draft java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Set to 'false' to create a published release.
generateReleaseNotes java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Set to 'true' to automatically generate the name and body for this release.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/release#id Release#id}.
name java.lang.String The name of the release.
prerelease java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Set to 'false' to identify the release as a full release.
targetCommitish java.lang.String The branch name or commit SHA the tag is created from.

connectionOptional
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>

forEachOptional
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider

provisionersOptional
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

repositoryRequired
public java.lang.String getRepository();
  • Type: java.lang.String

The name of the repository.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/release#repository Release#repository}


tagNameRequired
public java.lang.String getTagName();
  • Type: java.lang.String

The name of the tag.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/release#tag_name Release#tag_name}


bodyOptional
public java.lang.String getBody();
  • Type: java.lang.String

Text describing the contents of the tag.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/release#body Release#body}


discussionCategoryNameOptional
public java.lang.String getDiscussionCategoryName();
  • Type: java.lang.String

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/6.2.3/docs/resources/release#discussion_category_name Release#discussion_category_name}


draftOptional
public java.lang.Object getDraft();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Set to 'false' to create a published release.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/release#draft Release#draft}


generateReleaseNotesOptional
public java.lang.Object getGenerateReleaseNotes();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

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/6.2.3/docs/resources/release#generate_release_notes Release#generate_release_notes}


idOptional
public java.lang.String getId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/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.


nameOptional
public java.lang.String getName();
  • Type: java.lang.String

The name of the release.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/release#name Release#name}


prereleaseOptional
public java.lang.Object getPrerelease();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Set to 'false' to identify the release as a full release.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/release#prerelease Release#prerelease}


targetCommitishOptional
public java.lang.String getTargetCommitish();
  • Type: java.lang.String

The branch name or commit SHA the tag is created from.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/release#target_commitish Release#target_commitish}