akeyless.DynamicSecretGithub

akeyless 2.0.1, Apr 27 26

Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community

akeyless-community/terraform-provider-akeyless

Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community

akeyless-community/terraform-provider-akeyless

Create DynamicSecretGithub Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new DynamicSecretGithub(name: string, args?: DynamicSecretGithubArgs, opts?: CustomResourceOptions);

@overload
def DynamicSecretGithub(resource_name: str,
                        args: Optional[DynamicSecretGithubArgs] = None,
                        opts: Optional[ResourceOptions] = None)

@overload
def DynamicSecretGithub(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        delete_protection: Optional[str] = None,
                        description: Optional[str] = None,
                        dynamic_secret_github_id: Optional[str] = None,
                        github_app_id: Optional[float] = None,
                        github_app_private_key: Optional[str] = None,
                        github_base_url: Optional[str] = None,
                        installation_id: Optional[float] = None,
                        installation_organization: Optional[str] = None,
                        installation_repository: Optional[str] = None,
                        item_custom_fields: Optional[Mapping[str, str]] = None,
                        name: Optional[str] = None,
                        tags: Optional[Sequence[str]] = None,
                        target_name: Optional[str] = None,
                        token_permissions: Optional[Sequence[str]] = None,
                        token_repositories: Optional[Sequence[str]] = None,
                        token_ttl: Optional[str] = None)

func NewDynamicSecretGithub(ctx *Context, name string, args *DynamicSecretGithubArgs, opts ...ResourceOption) (*DynamicSecretGithub, error)

public DynamicSecretGithub(string name, DynamicSecretGithubArgs? args = null, CustomResourceOptions? opts = null)

public DynamicSecretGithub(String name, DynamicSecretGithubArgs args)
public DynamicSecretGithub(String name, DynamicSecretGithubArgs args, CustomResourceOptions options)

type: akeyless:DynamicSecretGithub
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args DynamicSecretGithubArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args DynamicSecretGithubArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args DynamicSecretGithubArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DynamicSecretGithubArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DynamicSecretGithubArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var dynamicSecretGithubResource = new Akeyless.DynamicSecretGithub("dynamicSecretGithubResource", new()
{
    DeleteProtection = "string",
    Description = "string",
    DynamicSecretGithubId = "string",
    GithubAppId = 0,
    GithubAppPrivateKey = "string",
    GithubBaseUrl = "string",
    InstallationId = 0,
    InstallationOrganization = "string",
    InstallationRepository = "string",
    ItemCustomFields = 
    {
        { "string", "string" },
    },
    Name = "string",
    Tags = new[]
    {
        "string",
    },
    TargetName = "string",
    TokenPermissions = new[]
    {
        "string",
    },
    TokenRepositories = new[]
    {
        "string",
    },
    TokenTtl = "string",
});

example, err := akeyless.NewDynamicSecretGithub(ctx, "dynamicSecretGithubResource", &akeyless.DynamicSecretGithubArgs{
	DeleteProtection:         pulumi.String("string"),
	Description:              pulumi.String("string"),
	DynamicSecretGithubId:    pulumi.String("string"),
	GithubAppId:              pulumi.Float64(0),
	GithubAppPrivateKey:      pulumi.String("string"),
	GithubBaseUrl:            pulumi.String("string"),
	InstallationId:           pulumi.Float64(0),
	InstallationOrganization: pulumi.String("string"),
	InstallationRepository:   pulumi.String("string"),
	ItemCustomFields: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	TargetName: pulumi.String("string"),
	TokenPermissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	TokenRepositories: pulumi.StringArray{
		pulumi.String("string"),
	},
	TokenTtl: pulumi.String("string"),
})

var dynamicSecretGithubResource = new DynamicSecretGithub("dynamicSecretGithubResource", DynamicSecretGithubArgs.builder()
    .deleteProtection("string")
    .description("string")
    .dynamicSecretGithubId("string")
    .githubAppId(0.0)
    .githubAppPrivateKey("string")
    .githubBaseUrl("string")
    .installationId(0.0)
    .installationOrganization("string")
    .installationRepository("string")
    .itemCustomFields(Map.of("string", "string"))
    .name("string")
    .tags("string")
    .targetName("string")
    .tokenPermissions("string")
    .tokenRepositories("string")
    .tokenTtl("string")
    .build());

dynamic_secret_github_resource = akeyless.DynamicSecretGithub("dynamicSecretGithubResource",
    delete_protection="string",
    description="string",
    dynamic_secret_github_id="string",
    github_app_id=float(0),
    github_app_private_key="string",
    github_base_url="string",
    installation_id=float(0),
    installation_organization="string",
    installation_repository="string",
    item_custom_fields={
        "string": "string",
    },
    name="string",
    tags=["string"],
    target_name="string",
    token_permissions=["string"],
    token_repositories=["string"],
    token_ttl="string")

const dynamicSecretGithubResource = new akeyless.DynamicSecretGithub("dynamicSecretGithubResource", {
    deleteProtection: "string",
    description: "string",
    dynamicSecretGithubId: "string",
    githubAppId: 0,
    githubAppPrivateKey: "string",
    githubBaseUrl: "string",
    installationId: 0,
    installationOrganization: "string",
    installationRepository: "string",
    itemCustomFields: {
        string: "string",
    },
    name: "string",
    tags: ["string"],
    targetName: "string",
    tokenPermissions: ["string"],
    tokenRepositories: ["string"],
    tokenTtl: "string",
});

type: akeyless:DynamicSecretGithub
properties:
    deleteProtection: string
    description: string
    dynamicSecretGithubId: string
    githubAppId: 0
    githubAppPrivateKey: string
    githubBaseUrl: string
    installationId: 0
    installationOrganization: string
    installationRepository: string
    itemCustomFields:
        string: string
    name: string
    tags:
        - string
    targetName: string
    tokenPermissions:
        - string
    tokenRepositories:
        - string
    tokenTtl: string

DynamicSecretGithub Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The DynamicSecretGithub resource accepts the following input properties:

DeleteProtection string: Protection from accidental deletion of this object [true/false]
Description string: Description of the object
DynamicSecretGithubId string: The ID of this resource.
GithubAppId double: Github app id
GithubAppPrivateKey string: App private key
GithubBaseUrl string: Base URL
InstallationId double: GitHub application installation id
InstallationOrganization string: Optional, mutually exclusive with installation id, GitHub organization name
InstallationRepository string: Optional, mutually exclusive with installation id, GitHub repository '\n\n/\n\n'
ItemCustomFields Dictionary<string, string>: Additional custom fields to associate with the item
Name string: Dynamic secret name
Tags List<string>: Add tags attached to this object
TargetName string: Target name
TokenPermissions List<string>: Optional - installation token's allowed permissions
TokenRepositories List<string>: Optional - installation token's allowed repositories
TokenTtl string: Token TTL

DeleteProtection string: Protection from accidental deletion of this object [true/false]
Description string: Description of the object
DynamicSecretGithubId string: The ID of this resource.
GithubAppId float64: Github app id
GithubAppPrivateKey string: App private key
GithubBaseUrl string: Base URL
InstallationId float64: GitHub application installation id
InstallationOrganization string: Optional, mutually exclusive with installation id, GitHub organization name
InstallationRepository string: Optional, mutually exclusive with installation id, GitHub repository '\n\n/\n\n'
ItemCustomFields map[string]string: Additional custom fields to associate with the item
Name string: Dynamic secret name
Tags []string: Add tags attached to this object
TargetName string: Target name
TokenPermissions []string: Optional - installation token's allowed permissions
TokenRepositories []string: Optional - installation token's allowed repositories
TokenTtl string: Token TTL

deleteProtection String: Protection from accidental deletion of this object [true/false]
description String: Description of the object
dynamicSecretGithubId String: The ID of this resource.
githubAppId Double: Github app id
githubAppPrivateKey String: App private key
githubBaseUrl String: Base URL
installationId Double: GitHub application installation id
installationOrganization String: Optional, mutually exclusive with installation id, GitHub organization name
installationRepository String: Optional, mutually exclusive with installation id, GitHub repository '\n\n/\n\n'
itemCustomFields Map<String,String>: Additional custom fields to associate with the item
name String: Dynamic secret name
tags List<String>: Add tags attached to this object
targetName String: Target name
tokenPermissions List<String>: Optional - installation token's allowed permissions
tokenRepositories List<String>: Optional - installation token's allowed repositories
tokenTtl String: Token TTL

deleteProtection string: Protection from accidental deletion of this object [true/false]
description string: Description of the object
dynamicSecretGithubId string: The ID of this resource.
githubAppId number: Github app id
githubAppPrivateKey string: App private key
githubBaseUrl string: Base URL
installationId number: GitHub application installation id
installationOrganization string: Optional, mutually exclusive with installation id, GitHub organization name
installationRepository string: Optional, mutually exclusive with installation id, GitHub repository '\n\n/\n\n'
itemCustomFields {[key: string]: string}: Additional custom fields to associate with the item
name string: Dynamic secret name
tags string[]: Add tags attached to this object
targetName string: Target name
tokenPermissions string[]: Optional - installation token's allowed permissions
tokenRepositories string[]: Optional - installation token's allowed repositories
tokenTtl string: Token TTL

delete_protection str: Protection from accidental deletion of this object [true/false]
description str: Description of the object
dynamic_secret_github_id str: The ID of this resource.
github_app_id float: Github app id
github_app_private_key str: App private key
github_base_url str: Base URL
installation_id float: GitHub application installation id
installation_organization str: Optional, mutually exclusive with installation id, GitHub organization name
installation_repository str: Optional, mutually exclusive with installation id, GitHub repository '\n\n/\n\n'
item_custom_fields Mapping[str, str]: Additional custom fields to associate with the item
name str: Dynamic secret name
tags Sequence[str]: Add tags attached to this object
target_name str: Target name
token_permissions Sequence[str]: Optional - installation token's allowed permissions
token_repositories Sequence[str]: Optional - installation token's allowed repositories
token_ttl str: Token TTL

deleteProtection String: Protection from accidental deletion of this object [true/false]
description String: Description of the object
dynamicSecretGithubId String: The ID of this resource.
githubAppId Number: Github app id
githubAppPrivateKey String: App private key
githubBaseUrl String: Base URL
installationId Number: GitHub application installation id
installationOrganization String: Optional, mutually exclusive with installation id, GitHub organization name
installationRepository String: Optional, mutually exclusive with installation id, GitHub repository '\n\n/\n\n'
itemCustomFields Map<String>: Additional custom fields to associate with the item
name String: Dynamic secret name
tags List<String>: Add tags attached to this object
targetName String: Target name
tokenPermissions List<String>: Optional - installation token's allowed permissions
tokenRepositories List<String>: Optional - installation token's allowed repositories
tokenTtl String: Token TTL

Outputs

All input properties are implicitly available as output properties. Additionally, the DynamicSecretGithub resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing DynamicSecretGithub Resource

Get an existing DynamicSecretGithub resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DynamicSecretGithubState, opts?: CustomResourceOptions): DynamicSecretGithub

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        delete_protection: Optional[str] = None,
        description: Optional[str] = None,
        dynamic_secret_github_id: Optional[str] = None,
        github_app_id: Optional[float] = None,
        github_app_private_key: Optional[str] = None,
        github_base_url: Optional[str] = None,
        installation_id: Optional[float] = None,
        installation_organization: Optional[str] = None,
        installation_repository: Optional[str] = None,
        item_custom_fields: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        target_name: Optional[str] = None,
        token_permissions: Optional[Sequence[str]] = None,
        token_repositories: Optional[Sequence[str]] = None,
        token_ttl: Optional[str] = None) -> DynamicSecretGithub

func GetDynamicSecretGithub(ctx *Context, name string, id IDInput, state *DynamicSecretGithubState, opts ...ResourceOption) (*DynamicSecretGithub, error)

public static DynamicSecretGithub Get(string name, Input<string> id, DynamicSecretGithubState? state, CustomResourceOptions? opts = null)

public static DynamicSecretGithub get(String name, Output<String> id, DynamicSecretGithubState state, CustomResourceOptions options)

resources:  _:    type: akeyless:DynamicSecretGithub    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

DeleteProtection string: Protection from accidental deletion of this object [true/false]
Description string: Description of the object
DynamicSecretGithubId string: The ID of this resource.
GithubAppId double: Github app id
GithubAppPrivateKey string: App private key
GithubBaseUrl string: Base URL
InstallationId double: GitHub application installation id
InstallationOrganization string: Optional, mutually exclusive with installation id, GitHub organization name
InstallationRepository string: Optional, mutually exclusive with installation id, GitHub repository '\n\n/\n\n'
ItemCustomFields Dictionary<string, string>: Additional custom fields to associate with the item
Name string: Dynamic secret name
Tags List<string>: Add tags attached to this object
TargetName string: Target name
TokenPermissions List<string>: Optional - installation token's allowed permissions
TokenRepositories List<string>: Optional - installation token's allowed repositories
TokenTtl string: Token TTL

DeleteProtection string: Protection from accidental deletion of this object [true/false]
Description string: Description of the object
DynamicSecretGithubId string: The ID of this resource.
GithubAppId float64: Github app id
GithubAppPrivateKey string: App private key
GithubBaseUrl string: Base URL
InstallationId float64: GitHub application installation id
InstallationOrganization string: Optional, mutually exclusive with installation id, GitHub organization name
InstallationRepository string: Optional, mutually exclusive with installation id, GitHub repository '\n\n/\n\n'
ItemCustomFields map[string]string: Additional custom fields to associate with the item
Name string: Dynamic secret name
Tags []string: Add tags attached to this object
TargetName string: Target name
TokenPermissions []string: Optional - installation token's allowed permissions
TokenRepositories []string: Optional - installation token's allowed repositories
TokenTtl string: Token TTL

deleteProtection String: Protection from accidental deletion of this object [true/false]
description String: Description of the object
dynamicSecretGithubId String: The ID of this resource.
githubAppId Double: Github app id
githubAppPrivateKey String: App private key
githubBaseUrl String: Base URL
installationId Double: GitHub application installation id
installationOrganization String: Optional, mutually exclusive with installation id, GitHub organization name
installationRepository String: Optional, mutually exclusive with installation id, GitHub repository '\n\n/\n\n'
itemCustomFields Map<String,String>: Additional custom fields to associate with the item
name String: Dynamic secret name
tags List<String>: Add tags attached to this object
targetName String: Target name
tokenPermissions List<String>: Optional - installation token's allowed permissions
tokenRepositories List<String>: Optional - installation token's allowed repositories
tokenTtl String: Token TTL

deleteProtection string: Protection from accidental deletion of this object [true/false]
description string: Description of the object
dynamicSecretGithubId string: The ID of this resource.
githubAppId number: Github app id
githubAppPrivateKey string: App private key
githubBaseUrl string: Base URL
installationId number: GitHub application installation id
installationOrganization string: Optional, mutually exclusive with installation id, GitHub organization name
installationRepository string: Optional, mutually exclusive with installation id, GitHub repository '\n\n/\n\n'
itemCustomFields {[key: string]: string}: Additional custom fields to associate with the item
name string: Dynamic secret name
tags string[]: Add tags attached to this object
targetName string: Target name
tokenPermissions string[]: Optional - installation token's allowed permissions
tokenRepositories string[]: Optional - installation token's allowed repositories
tokenTtl string: Token TTL

delete_protection str: Protection from accidental deletion of this object [true/false]
description str: Description of the object
dynamic_secret_github_id str: The ID of this resource.
github_app_id float: Github app id
github_app_private_key str: App private key
github_base_url str: Base URL
installation_id float: GitHub application installation id
installation_organization str: Optional, mutually exclusive with installation id, GitHub organization name
installation_repository str: Optional, mutually exclusive with installation id, GitHub repository '\n\n/\n\n'
item_custom_fields Mapping[str, str]: Additional custom fields to associate with the item
name str: Dynamic secret name
tags Sequence[str]: Add tags attached to this object
target_name str: Target name
token_permissions Sequence[str]: Optional - installation token's allowed permissions
token_repositories Sequence[str]: Optional - installation token's allowed repositories
token_ttl str: Token TTL

deleteProtection String: Protection from accidental deletion of this object [true/false]
description String: Description of the object
dynamicSecretGithubId String: The ID of this resource.
githubAppId Number: Github app id
githubAppPrivateKey String: App private key
githubBaseUrl String: Base URL
installationId Number: GitHub application installation id
installationOrganization String: Optional, mutually exclusive with installation id, GitHub organization name
installationRepository String: Optional, mutually exclusive with installation id, GitHub repository '\n\n/\n\n'
itemCustomFields Map<String>: Additional custom fields to associate with the item
name String: Dynamic secret name
tags List<String>: Add tags attached to this object
targetName String: Target name
tokenPermissions List<String>: Optional - installation token's allowed permissions
tokenRepositories List<String>: Optional - installation token's allowed repositories
tokenTtl String: Token TTL