Represents a {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/data-sources/release github_release}.
from cdktn_provider_github import data_github_release
dataGithubRelease.DataGithubRelease(
scope: Construct,
id: str,
connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
count: typing.Union[int, float] | TerraformCount = None,
depends_on: typing.List[ITerraformDependable] = None,
for_each: ITerraformIterator = None,
lifecycle: TerraformResourceLifecycle = None,
provider: TerraformProvider = None,
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
owner: str,
repository: str,
retrieve_by: str,
id: str = None,
release_id: typing.Union[int, float] = None,
release_tag: str = None
)| Name | Type | Description |
|---|---|---|
scope |
constructs.Construct |
The scope in which to define this construct. |
id |
str |
The scoped construct ID. |
connection |
cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection |
No description. |
count |
typing.Union[int, float] | cdktn.TerraformCount |
No description. |
depends_on |
typing.List[cdktn.ITerraformDependable] |
No description. |
for_each |
cdktn.ITerraformIterator |
No description. |
lifecycle |
cdktn.TerraformResourceLifecycle |
No description. |
provider |
cdktn.TerraformProvider |
No description. |
provisioners |
typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] |
No description. |
owner |
str |
Owner of the repository. |
repository |
str |
Name of the repository to retrieve the release from. |
retrieve_by |
str |
Describes how to fetch the release. Valid values are id, tag, latest. |
id |
str |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/data-sources/release#id DataGithubRelease#id}. |
release_id |
typing.Union[int, float] |
ID of the release to retrieve. Must be specified when retrieve_by = id. |
release_tag |
str |
ID of the release to retrieve. Must be specified when retrieve_by = tag. |
- Type: constructs.Construct
The scope in which to define this construct.
- Type: str
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
- Type: typing.Union[int, float] | cdktn.TerraformCount
- Type: typing.List[cdktn.ITerraformDependable]
- Type: cdktn.ITerraformIterator
- Type: cdktn.TerraformResourceLifecycle
- Type: cdktn.TerraformProvider
- Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]
- Type: str
Owner of the repository.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/data-sources/release#owner DataGithubRelease#owner}
- Type: str
Name of the repository to retrieve the release from.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/data-sources/release#repository DataGithubRelease#repository}
- Type: str
Describes how to fetch the release. Valid values are id, tag, latest.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/data-sources/release#retrieve_by DataGithubRelease#retrieve_by}
- Type: str
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/data-sources/release#id DataGithubRelease#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.
- Type: typing.Union[int, float]
ID of the release to retrieve. Must be specified when retrieve_by = id.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/data-sources/release#release_id DataGithubRelease#release_id}
- Type: str
ID of the release to retrieve. Must be specified when retrieve_by = tag.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/data-sources/release#release_tag DataGithubRelease#release_tag}
| Name | Description |
|---|---|
to_string |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
add_override |
No description. |
override_logical_id |
Overrides the auto-generated logical ID with a specific ID. |
reset_override_logical_id |
Resets a previously passed logical Id to use the auto-generated logical id again. |
to_hcl_terraform |
Adds this resource to the terraform JSON output. |
to_metadata |
No description. |
to_terraform |
Adds this resource to the terraform JSON output. |
get_any_map_attribute |
No description. |
get_boolean_attribute |
No description. |
get_boolean_map_attribute |
No description. |
get_list_attribute |
No description. |
get_number_attribute |
No description. |
get_number_list_attribute |
No description. |
get_number_map_attribute |
No description. |
get_string_attribute |
No description. |
get_string_map_attribute |
No description. |
interpolation_for_attribute |
No description. |
reset_id |
No description. |
reset_release_id |
No description. |
reset_release_tag |
No description. |
def to_string() -> strReturns a string representation of this construct.
def with(
mixins: *IMixin
) -> IConstructApplies 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.
- Type: *constructs.IMixin
The mixins to apply.
def add_override(
path: str,
value: typing.Any
) -> None- Type: str
- Type: typing.Any
def override_logical_id(
new_logical_id: str
) -> NoneOverrides the auto-generated logical ID with a specific ID.
- Type: str
The new logical ID to use for this stack element.
def reset_override_logical_id() -> NoneResets a previously passed logical Id to use the auto-generated logical id again.
def to_hcl_terraform() -> typing.AnyAdds this resource to the terraform JSON output.
def to_metadata() -> typing.Anydef to_terraform() -> typing.AnyAdds this resource to the terraform JSON output.
def get_any_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Any]- Type: str
def get_boolean_attribute(
terraform_attribute: str
) -> IResolvable- Type: str
def get_boolean_map_attribute(
terraform_attribute: str
) -> typing.Mapping[bool]- Type: str
def get_list_attribute(
terraform_attribute: str
) -> typing.List[str]- Type: str
def get_number_attribute(
terraform_attribute: str
) -> typing.Union[int, float]- Type: str
def get_number_list_attribute(
terraform_attribute: str
) -> typing.List[typing.Union[int, float]]- Type: str
def get_number_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]- Type: str
def get_string_attribute(
terraform_attribute: str
) -> str- Type: str
def get_string_map_attribute(
terraform_attribute: str
) -> typing.Mapping[str]- Type: str
def interpolation_for_attribute(
terraform_attribute: str
) -> IResolvable- Type: str
def reset_id() -> Nonedef reset_release_id() -> Nonedef reset_release_tag() -> None| Name | Description |
|---|---|
is_construct |
Checks if x is a construct. |
is_terraform_element |
No description. |
is_terraform_data_source |
No description. |
generate_config_for_import |
Generates CDKTN code for importing a DataGithubRelease resource upon running "cdktn plan ". |
from cdktn_provider_github import data_github_release
dataGithubRelease.DataGithubRelease.is_construct(
x: typing.Any
)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.
- Type: typing.Any
Any object.
from cdktn_provider_github import data_github_release
dataGithubRelease.DataGithubRelease.is_terraform_element(
x: typing.Any
)- Type: typing.Any
from cdktn_provider_github import data_github_release
dataGithubRelease.DataGithubRelease.is_terraform_data_source(
x: typing.Any
)- Type: typing.Any
from cdktn_provider_github import data_github_release
dataGithubRelease.DataGithubRelease.generate_config_for_import(
scope: Construct,
import_to_id: str,
import_from_id: str,
provider: TerraformProvider = None
)Generates CDKTN code for importing a DataGithubRelease resource upon running "cdktn plan ".
- Type: constructs.Construct
The scope in which to define this construct.
- Type: str
The construct id used in the generated config for the DataGithubRelease to import.
- Type: str
The id of the existing DataGithubRelease that should be imported.
Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/data-sources/release#import import section} in the documentation of this resource for the id to use
- Type: cdktn.TerraformProvider
? Optional instance of the provider where the DataGithubRelease to import is found.
| Name | Type | Description |
|---|---|---|
node |
constructs.Node |
The tree node. |
cdktf_stack |
cdktn.TerraformStack |
No description. |
fqn |
str |
No description. |
friendly_unique_id |
str |
No description. |
terraform_meta_arguments |
typing.Mapping[typing.Any] |
No description. |
terraform_resource_type |
str |
No description. |
terraform_generator_metadata |
cdktn.TerraformProviderGeneratorMetadata |
No description. |
count |
typing.Union[int, float] | cdktn.TerraformCount |
No description. |
depends_on |
typing.List[str] |
No description. |
for_each |
cdktn.ITerraformIterator |
No description. |
lifecycle |
cdktn.TerraformResourceLifecycle |
No description. |
provider |
cdktn.TerraformProvider |
No description. |
asserts_url |
str |
No description. |
assets |
DataGithubReleaseAssetsList |
No description. |
assets_url |
str |
No description. |
body |
str |
No description. |
created_at |
str |
No description. |
draft |
cdktn.IResolvable |
No description. |
html_url |
str |
No description. |
name |
str |
No description. |
prerelease |
cdktn.IResolvable |
No description. |
published_at |
str |
No description. |
tarball_url |
str |
No description. |
target_commitish |
str |
No description. |
upload_url |
str |
No description. |
url |
str |
No description. |
zipball_url |
str |
No description. |
id_input |
str |
No description. |
owner_input |
str |
No description. |
release_id_input |
typing.Union[int, float] |
No description. |
release_tag_input |
str |
No description. |
repository_input |
str |
No description. |
retrieve_by_input |
str |
No description. |
id |
str |
No description. |
owner |
str |
No description. |
release_id |
typing.Union[int, float] |
No description. |
release_tag |
str |
No description. |
repository |
str |
No description. |
retrieve_by |
str |
No description. |
node: Node- Type: constructs.Node
The tree node.
cdktf_stack: TerraformStack- Type: cdktn.TerraformStack
fqn: str- Type: str
friendly_unique_id: str- Type: str
terraform_meta_arguments: typing.Mapping[typing.Any]- Type: typing.Mapping[typing.Any]
terraform_resource_type: str- Type: str
terraform_generator_metadata: TerraformProviderGeneratorMetadata- Type: cdktn.TerraformProviderGeneratorMetadata
count: typing.Union[int, float] | TerraformCount- Type: typing.Union[int, float] | cdktn.TerraformCount
depends_on: typing.List[str]- Type: typing.List[str]
for_each: ITerraformIterator- Type: cdktn.ITerraformIterator
lifecycle: TerraformResourceLifecycle- Type: cdktn.TerraformResourceLifecycle
provider: TerraformProvider- Type: cdktn.TerraformProvider
asserts_url: str- Type: str
assets: DataGithubReleaseAssetsListassets_url: str- Type: str
body: str- Type: str
created_at: str- Type: str
draft: IResolvable- Type: cdktn.IResolvable
html_url: str- Type: str
name: str- Type: str
prerelease: IResolvable- Type: cdktn.IResolvable
published_at: str- Type: str
tarball_url: str- Type: str
target_commitish: str- Type: str
upload_url: str- Type: str
url: str- Type: str
zipball_url: str- Type: str
id_input: str- Type: str
owner_input: str- Type: str
release_id_input: typing.Union[int, float]- Type: typing.Union[int, float]
release_tag_input: str- Type: str
repository_input: str- Type: str
retrieve_by_input: str- Type: str
id: str- Type: str
owner: str- Type: str
release_id: typing.Union[int, float]- Type: typing.Union[int, float]
release_tag: str- Type: str
repository: str- Type: str
retrieve_by: str- Type: str
| Name | Type | Description |
|---|---|---|
tfResourceType |
str |
No description. |
tfResourceType: str- Type: str
from cdktn_provider_github import data_github_release
dataGithubRelease.DataGithubReleaseAssets()from cdktn_provider_github import data_github_release
dataGithubRelease.DataGithubReleaseConfig(
connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
count: typing.Union[int, float] | TerraformCount = None,
depends_on: typing.List[ITerraformDependable] = None,
for_each: ITerraformIterator = None,
lifecycle: TerraformResourceLifecycle = None,
provider: TerraformProvider = None,
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
owner: str,
repository: str,
retrieve_by: str,
id: str = None,
release_id: typing.Union[int, float] = None,
release_tag: str = None
)| Name | Type | Description |
|---|---|---|
connection |
cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection |
No description. |
count |
typing.Union[int, float] | cdktn.TerraformCount |
No description. |
depends_on |
typing.List[cdktn.ITerraformDependable] |
No description. |
for_each |
cdktn.ITerraformIterator |
No description. |
lifecycle |
cdktn.TerraformResourceLifecycle |
No description. |
provider |
cdktn.TerraformProvider |
No description. |
provisioners |
typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] |
No description. |
owner |
str |
Owner of the repository. |
repository |
str |
Name of the repository to retrieve the release from. |
retrieve_by |
str |
Describes how to fetch the release. Valid values are id, tag, latest. |
id |
str |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/data-sources/release#id DataGithubRelease#id}. |
release_id |
typing.Union[int, float] |
ID of the release to retrieve. Must be specified when retrieve_by = id. |
release_tag |
str |
ID of the release to retrieve. Must be specified when retrieve_by = tag. |
connection: SSHProvisionerConnection | WinrmProvisionerConnection- Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
count: typing.Union[int, float] | TerraformCount- Type: typing.Union[int, float] | cdktn.TerraformCount
depends_on: typing.List[ITerraformDependable]- Type: typing.List[cdktn.ITerraformDependable]
for_each: ITerraformIterator- Type: cdktn.ITerraformIterator
lifecycle: TerraformResourceLifecycle- Type: cdktn.TerraformResourceLifecycle
provider: TerraformProvider- Type: cdktn.TerraformProvider
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]- Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]
owner: str- Type: str
Owner of the repository.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/data-sources/release#owner DataGithubRelease#owner}
repository: str- Type: str
Name of the repository to retrieve the release from.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/data-sources/release#repository DataGithubRelease#repository}
retrieve_by: str- Type: str
Describes how to fetch the release. Valid values are id, tag, latest.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/data-sources/release#retrieve_by DataGithubRelease#retrieve_by}
id: str- Type: str
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/data-sources/release#id DataGithubRelease#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.
release_id: typing.Union[int, float]- Type: typing.Union[int, float]
ID of the release to retrieve. Must be specified when retrieve_by = id.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/data-sources/release#release_id DataGithubRelease#release_id}
release_tag: str- Type: str
ID of the release to retrieve. Must be specified when retrieve_by = tag.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/data-sources/release#release_tag DataGithubRelease#release_tag}
from cdktn_provider_github import data_github_release
dataGithubRelease.DataGithubReleaseAssetsList(
terraform_resource: IInterpolatingParent,
terraform_attribute: str,
wraps_set: bool
)| Name | Type | Description |
|---|---|---|
terraform_resource |
cdktn.IInterpolatingParent |
The parent resource. |
terraform_attribute |
str |
The attribute on the parent resource this class is referencing. |
wraps_set |
bool |
whether the list is wrapping a set (will add tolist() to be able to access an item via an index). |
- Type: cdktn.IInterpolatingParent
The parent resource.
- Type: str
The attribute on the parent resource this class is referencing.
- Type: bool
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
| Name | Description |
|---|---|
all_with_map_key |
Creating an iterator for this complex list. |
compute_fqn |
No description. |
resolve |
Produce the Token's value at resolution time. |
to_string |
Return a string representation of this resolvable object. |
get |
No description. |
def all_with_map_key(
map_key_attribute_name: str
) -> DynamicListTerraformIteratorCreating an iterator for this complex list.
The list will be converted into a map with the mapKeyAttributeName as the key.
- Type: str
def compute_fqn() -> strdef resolve(
_context: IResolveContext
) -> typing.AnyProduce the Token's value at resolution time.
- Type: cdktn.IResolveContext
def to_string() -> strReturn a string representation of this resolvable object.
Returns a reversible string representation.
def get(
index: typing.Union[int, float]
) -> DataGithubReleaseAssetsOutputReference- Type: typing.Union[int, float]
the index of the item to return.
| Name | Type | Description |
|---|---|---|
creation_stack |
typing.List[str] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
str |
No description. |
creation_stack: typing.List[str]- Type: typing.List[str]
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.
fqn: str- Type: str
from cdktn_provider_github import data_github_release
dataGithubRelease.DataGithubReleaseAssetsOutputReference(
terraform_resource: IInterpolatingParent,
terraform_attribute: str,
complex_object_index: typing.Union[int, float],
complex_object_is_from_set: bool
)| Name | Type | Description |
|---|---|---|
terraform_resource |
cdktn.IInterpolatingParent |
The parent resource. |
terraform_attribute |
str |
The attribute on the parent resource this class is referencing. |
complex_object_index |
typing.Union[int, float] |
the index of this item in the list. |
complex_object_is_from_set |
bool |
whether the list is wrapping a set (will add tolist() to be able to access an item via an index). |
- Type: cdktn.IInterpolatingParent
The parent resource.
- Type: str
The attribute on the parent resource this class is referencing.
- Type: typing.Union[int, float]
the index of this item in the list.
- Type: bool
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
| Name | Description |
|---|---|
compute_fqn |
No description. |
get_any_map_attribute |
No description. |
get_boolean_attribute |
No description. |
get_boolean_map_attribute |
No description. |
get_list_attribute |
No description. |
get_number_attribute |
No description. |
get_number_list_attribute |
No description. |
get_number_map_attribute |
No description. |
get_string_attribute |
No description. |
get_string_map_attribute |
No description. |
interpolation_for_attribute |
No description. |
resolve |
Produce the Token's value at resolution time. |
to_string |
Return a string representation of this resolvable object. |
def compute_fqn() -> strdef get_any_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Any]- Type: str
def get_boolean_attribute(
terraform_attribute: str
) -> IResolvable- Type: str
def get_boolean_map_attribute(
terraform_attribute: str
) -> typing.Mapping[bool]- Type: str
def get_list_attribute(
terraform_attribute: str
) -> typing.List[str]- Type: str
def get_number_attribute(
terraform_attribute: str
) -> typing.Union[int, float]- Type: str
def get_number_list_attribute(
terraform_attribute: str
) -> typing.List[typing.Union[int, float]]- Type: str
def get_number_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]- Type: str
def get_string_attribute(
terraform_attribute: str
) -> str- Type: str
def get_string_map_attribute(
terraform_attribute: str
) -> typing.Mapping[str]- Type: str
def interpolation_for_attribute(
property: str
) -> IResolvable- Type: str
def resolve(
_context: IResolveContext
) -> typing.AnyProduce the Token's value at resolution time.
- Type: cdktn.IResolveContext
def to_string() -> strReturn a string representation of this resolvable object.
Returns a reversible string representation.
| Name | Type | Description |
|---|---|---|
creation_stack |
typing.List[str] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
str |
No description. |
browser_download_url |
str |
No description. |
content_type |
str |
No description. |
created_at |
str |
No description. |
id |
typing.Union[int, float] |
No description. |
label |
str |
No description. |
name |
str |
No description. |
node_id |
str |
No description. |
size |
typing.Union[int, float] |
No description. |
updated_at |
str |
No description. |
url |
str |
No description. |
internal_value |
DataGithubReleaseAssets |
No description. |
creation_stack: typing.List[str]- Type: typing.List[str]
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.
fqn: str- Type: str
browser_download_url: str- Type: str
content_type: str- Type: str
created_at: str- Type: str
id: typing.Union[int, float]- Type: typing.Union[int, float]
label: str- Type: str
name: str- Type: str
node_id: str- Type: str
size: typing.Union[int, float]- Type: typing.Union[int, float]
updated_at: str- Type: str
url: str- Type: str
internal_value: DataGithubReleaseAssets- Type: DataGithubReleaseAssets