Skip to content

dataGithubReleaseAsset.java.md

Latest commit

 

History

History
1092 lines (681 loc) · 49.4 KB

dataGithubReleaseAsset.java.md

File metadata and controls

1092 lines (681 loc) · 49.4 KB

dataGithubReleaseAsset Submodule

Constructs

DataGithubReleaseAsset

Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset github_release_asset}.

Initializers 

import io.cdktn.providers.github.data_github_release_asset.DataGithubReleaseAsset;

DataGithubReleaseAsset.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection|WinrmProvisionerConnection)
//  .count(java.lang.Number|TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner>)
    .assetId(java.lang.Number)
    .owner(java.lang.String)
    .repository(java.lang.String)
//  .downloadFileContents(java.lang.Boolean|IResolvable)
//  .id(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 io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection No description.
count java.lang.Number|io.cdktn.cdktn.TerraformCount No description.
dependsOn java.util.List<io.cdktn.cdktn.ITerraformDependable> No description.
forEach io.cdktn.cdktn.ITerraformIterator No description.
lifecycle io.cdktn.cdktn.TerraformResourceLifecycle No description.
provider io.cdktn.cdktn.TerraformProvider No description.
provisioners java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner> No description.
assetId java.lang.Number ID of the release asset to retrieve.
owner java.lang.String Owner of the repository.
repository java.lang.String Name of the repository to retrieve the release asset from.
downloadFileContents java.lang.Boolean|io.cdktn.cdktn.IResolvable Whether to download the asset file content into the file_contents attribute.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#id DataGithubReleaseAsset#id}.
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: io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number|io.cdktn.cdktn.TerraformCount
dependsOnOptional
  • Type: java.util.List<io.cdktn.cdktn.ITerraformDependable>
forEachOptional
  • Type: io.cdktn.cdktn.ITerraformIterator
lifecycleOptional
  • Type: io.cdktn.cdktn.TerraformResourceLifecycle
providerOptional
  • Type: io.cdktn.cdktn.TerraformProvider
provisionersOptional
  • Type: java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner>
assetIdRequired
  • Type: java.lang.Number

ID of the release asset to retrieve.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#asset_id DataGithubReleaseAsset#asset_id}

ownerRequired
  • Type: java.lang.String

Owner of the repository.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#owner DataGithubReleaseAsset#owner}

repositoryRequired
  • Type: java.lang.String

Name of the repository to retrieve the release asset from.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#repository DataGithubReleaseAsset#repository}

downloadFileContentsOptional
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

Whether to download the asset file content into the file_contents attribute.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#download_file_contents DataGithubReleaseAsset#download_file_contents}

idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#id DataGithubReleaseAsset#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.

Methods

Name Description
toString Returns a string representation of this construct.
with Applies one or more mixins to 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 Adds this resource to the terraform JSON output.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
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.
resetDownloadFileContents No description.
resetId No description.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

with 
public IConstruct with(IMixin... mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixinsRequired
  • Type: software.constructs.IMixin...

The mixins to apply.

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()

Adds this resource to the terraform JSON output.

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

Adds this resource to the terraform JSON output.

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
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
resetDownloadFileContents 
public void resetDownloadFileContents()
resetId 
public void resetId()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformDataSource No description.
generateConfigForImport Generates CDKTN code for importing a DataGithubReleaseAsset resource upon running "cdktn plan ".
isConstruct 
import io.cdktn.providers.github.data_github_release_asset.DataGithubReleaseAsset;

DataGithubReleaseAsset.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 io.cdktn.providers.github.data_github_release_asset.DataGithubReleaseAsset;

DataGithubReleaseAsset.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformDataSource 
import io.cdktn.providers.github.data_github_release_asset.DataGithubReleaseAsset;

DataGithubReleaseAsset.isTerraformDataSource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import io.cdktn.providers.github.data_github_release_asset.DataGithubReleaseAsset;

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

Generates CDKTN code for importing a DataGithubReleaseAsset resource upon running "cdktn 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 DataGithubReleaseAsset to import.

importFromIdRequired
  • Type: java.lang.String

The id of the existing DataGithubReleaseAsset that should be imported.

Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: io.cdktn.cdktn.TerraformProvider

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

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack io.cdktn.cdktn.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 io.cdktn.cdktn.TerraformProviderGeneratorMetadata No description.
count java.lang.Number|io.cdktn.cdktn.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach io.cdktn.cdktn.ITerraformIterator No description.
lifecycle io.cdktn.cdktn.TerraformResourceLifecycle No description.
provider io.cdktn.cdktn.TerraformProvider No description.
browserDownloadUrl java.lang.String No description.
contentType java.lang.String No description.
createdAt java.lang.String No description.
fileContents java.lang.String No description.
label java.lang.String No description.
name java.lang.String No description.
nodeId java.lang.String No description.
size java.lang.Number No description.
updatedAt java.lang.String No description.
url java.lang.String No description.
assetIdInput java.lang.Number No description.
downloadFileContentsInput java.lang.Boolean|io.cdktn.cdktn.IResolvable No description.
idInput java.lang.String No description.
ownerInput java.lang.String No description.
repositoryInput java.lang.String No description.
assetId java.lang.Number No description.
downloadFileContents java.lang.Boolean|io.cdktn.cdktn.IResolvable No description.
id java.lang.String No description.
owner java.lang.String No description.
repository java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: io.cdktn.cdktn.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: io.cdktn.cdktn.TerraformProviderGeneratorMetadata
countOptional 
public java.lang.Number|TerraformCount getCount();
  • Type: java.lang.Number|io.cdktn.cdktn.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: io.cdktn.cdktn.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: io.cdktn.cdktn.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: io.cdktn.cdktn.TerraformProvider
browserDownloadUrlRequired 
public java.lang.String getBrowserDownloadUrl();
  • Type: java.lang.String
contentTypeRequired 
public java.lang.String getContentType();
  • Type: java.lang.String
createdAtRequired 
public java.lang.String getCreatedAt();
  • Type: java.lang.String
fileContentsRequired 
public java.lang.String getFileContents();
  • Type: java.lang.String
labelRequired 
public java.lang.String getLabel();
  • Type: java.lang.String
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
nodeIdRequired 
public java.lang.String getNodeId();
  • Type: java.lang.String
sizeRequired 
public java.lang.Number getSize();
  • Type: java.lang.Number
updatedAtRequired 
public java.lang.String getUpdatedAt();
  • Type: java.lang.String
urlRequired 
public java.lang.String getUrl();
  • Type: java.lang.String
assetIdInputOptional 
public java.lang.Number getAssetIdInput();
  • Type: java.lang.Number
downloadFileContentsInputOptional 
public java.lang.Boolean|IResolvable getDownloadFileContentsInput();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
ownerInputOptional 
public java.lang.String getOwnerInput();
  • Type: java.lang.String
repositoryInputOptional 
public java.lang.String getRepositoryInput();
  • Type: java.lang.String
assetIdRequired 
public java.lang.Number getAssetId();
  • Type: java.lang.Number
downloadFileContentsRequired 
public java.lang.Boolean|IResolvable getDownloadFileContents();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
ownerRequired 
public java.lang.String getOwner();
  • Type: java.lang.String
repositoryRequired 
public java.lang.String getRepository();
  • 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

DataGithubReleaseAssetConfig

Initializer 

import io.cdktn.providers.github.data_github_release_asset.DataGithubReleaseAssetConfig;

DataGithubReleaseAssetConfig.builder()
//  .connection(SSHProvisionerConnection|WinrmProvisionerConnection)
//  .count(java.lang.Number|TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner>)
    .assetId(java.lang.Number)
    .owner(java.lang.String)
    .repository(java.lang.String)
//  .downloadFileContents(java.lang.Boolean|IResolvable)
//  .id(java.lang.String)
    .build();

Properties

Name Type Description
connection io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection No description.
count java.lang.Number|io.cdktn.cdktn.TerraformCount No description.
dependsOn java.util.List<io.cdktn.cdktn.ITerraformDependable> No description.
forEach io.cdktn.cdktn.ITerraformIterator No description.
lifecycle io.cdktn.cdktn.TerraformResourceLifecycle No description.
provider io.cdktn.cdktn.TerraformProvider No description.
provisioners java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner> No description.
assetId java.lang.Number ID of the release asset to retrieve.
owner java.lang.String Owner of the repository.
repository java.lang.String Name of the repository to retrieve the release asset from.
downloadFileContents java.lang.Boolean|io.cdktn.cdktn.IResolvable Whether to download the asset file content into the file_contents attribute.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#id DataGithubReleaseAsset#id}.
connectionOptional 
public SSHProvisionerConnection|WinrmProvisionerConnection getConnection();
  • Type: io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection
countOptional 
public java.lang.Number|TerraformCount getCount();
  • Type: java.lang.Number|io.cdktn.cdktn.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<io.cdktn.cdktn.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: io.cdktn.cdktn.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: io.cdktn.cdktn.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: io.cdktn.cdktn.TerraformProvider
provisionersOptional 
public java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner> getProvisioners();
  • Type: java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner>
assetIdRequired 
public java.lang.Number getAssetId();
  • Type: java.lang.Number

ID of the release asset to retrieve.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#asset_id DataGithubReleaseAsset#asset_id}

ownerRequired 
public java.lang.String getOwner();
  • Type: java.lang.String

Owner of the repository.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#owner DataGithubReleaseAsset#owner}

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

Name of the repository to retrieve the release asset from.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#repository DataGithubReleaseAsset#repository}

downloadFileContentsOptional 
public java.lang.Boolean|IResolvable getDownloadFileContents();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

Whether to download the asset file content into the file_contents attribute.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#download_file_contents DataGithubReleaseAsset#download_file_contents}

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#id DataGithubReleaseAsset#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.