akeyless 1.9.0, Apr 14 25

akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community

akeyless-community/terraform-provider-akeyless

akeyless.DynamicSecretGithub

Explore with Pulumi AI

akeyless 1.9.0 published on Monday, Apr 14, 2025 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.

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,
                        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,
                        name: Optional[str] = None,
                        target_name: Optional[str] = None,
                        token_permissions: Optional[Sequence[str]] = None,
                        token_repositories: Optional[Sequence[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.

TypeScript
Python
Go
C#
Java
YAML

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

example, err := akeyless.NewDynamicSecretGithub(ctx, "dynamicSecretGithubResource", &akeyless.DynamicSecretGithubArgs{
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"),
Name: pulumi.String("string"),
TargetName: pulumi.String("string"),
TokenPermissions: pulumi.StringArray{
pulumi.String("string"),
},
TokenRepositories: pulumi.StringArray{
pulumi.String("string"),
},
})

var dynamicSecretGithubResource = new DynamicSecretGithub("dynamicSecretGithubResource", DynamicSecretGithubArgs.builder()
    .dynamicSecretGithubId("string")
    .githubAppId(0)
    .githubAppPrivateKey("string")
    .githubBaseUrl("string")
    .installationId(0)
    .installationOrganization("string")
    .installationRepository("string")
    .name("string")
    .targetName("string")
    .tokenPermissions("string")
    .tokenRepositories("string")
    .build());

dynamic_secret_github_resource = akeyless.DynamicSecretGithub("dynamicSecretGithubResource",
    dynamic_secret_github_id="string",
    github_app_id=0,
    github_app_private_key="string",
    github_base_url="string",
    installation_id=0,
    installation_organization="string",
    installation_repository="string",
    name="string",
    target_name="string",
    token_permissions=["string"],
    token_repositories=["string"])

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

type: akeyless:DynamicSecretGithub
properties:
    dynamicSecretGithubId: string
    githubAppId: 0
    githubAppPrivateKey: string
    githubBaseUrl: string
    installationId: 0
    installationOrganization: string
    installationRepository: string
    name: string
    targetName: string
    tokenPermissions:
        - string
    tokenRepositories:
        - 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:

DynamicSecretGithubId string: The ID of this resource.
GithubAppId double: Github application id
GithubAppPrivateKey string: Github application private key (base64 encoded key)
GithubBaseUrl string: Github base url
InstallationId double: Github application installation id
InstallationOrganization string: Instead of installation id, set a GitHub organization name
InstallationRepository string: Instead of installation id, set a GitHub repository '\n\n/\n\n'
Name string: Dynamic secret name
TargetName string: Name of existing target to use in dynamic secret creation
TokenPermissions List<string>: Tokens' allowed permissions. By default use installation allowed permissions. Input format: key=value pairs or JSON strings, e.g - -p contents=read -p issues=write or -p '{content:read}'
TokenRepositories List<string>: Tokens' allowed repositories. By default use installation allowed repositories. To specify multiple repositories use argument multiple times: -r RepoName1 -r RepoName2

DynamicSecretGithubId string: The ID of this resource.
GithubAppId float64: Github application id
GithubAppPrivateKey string: Github application private key (base64 encoded key)
GithubBaseUrl string: Github base url
InstallationId float64: Github application installation id
InstallationOrganization string: Instead of installation id, set a GitHub organization name
InstallationRepository string: Instead of installation id, set a GitHub repository '\n\n/\n\n'
Name string: Dynamic secret name
TargetName string: Name of existing target to use in dynamic secret creation
TokenPermissions []string: Tokens' allowed permissions. By default use installation allowed permissions. Input format: key=value pairs or JSON strings, e.g - -p contents=read -p issues=write or -p '{content:read}'
TokenRepositories []string: Tokens' allowed repositories. By default use installation allowed repositories. To specify multiple repositories use argument multiple times: -r RepoName1 -r RepoName2

dynamicSecretGithubId String: The ID of this resource.
githubAppId Double: Github application id
githubAppPrivateKey String: Github application private key (base64 encoded key)
githubBaseUrl String: Github base url
installationId Double: Github application installation id
installationOrganization String: Instead of installation id, set a GitHub organization name
installationRepository String: Instead of installation id, set a GitHub repository '\n\n/\n\n'
name String: Dynamic secret name
targetName String: Name of existing target to use in dynamic secret creation
tokenPermissions List<String>: Tokens' allowed permissions. By default use installation allowed permissions. Input format: key=value pairs or JSON strings, e.g - -p contents=read -p issues=write or -p '{content:read}'
tokenRepositories List<String>: Tokens' allowed repositories. By default use installation allowed repositories. To specify multiple repositories use argument multiple times: -r RepoName1 -r RepoName2

dynamicSecretGithubId string: The ID of this resource.
githubAppId number: Github application id
githubAppPrivateKey string: Github application private key (base64 encoded key)
githubBaseUrl string: Github base url
installationId number: Github application installation id
installationOrganization string: Instead of installation id, set a GitHub organization name
installationRepository string: Instead of installation id, set a GitHub repository '\n\n/\n\n'
name string: Dynamic secret name
targetName string: Name of existing target to use in dynamic secret creation
tokenPermissions string[]: Tokens' allowed permissions. By default use installation allowed permissions. Input format: key=value pairs or JSON strings, e.g - -p contents=read -p issues=write or -p '{content:read}'
tokenRepositories string[]: Tokens' allowed repositories. By default use installation allowed repositories. To specify multiple repositories use argument multiple times: -r RepoName1 -r RepoName2

dynamic_secret_github_id str: The ID of this resource.
github_app_id float: Github application id
github_app_private_key str: Github application private key (base64 encoded key)
github_base_url str: Github base url
installation_id float: Github application installation id
installation_organization str: Instead of installation id, set a GitHub organization name
installation_repository str: Instead of installation id, set a GitHub repository '\n\n/\n\n'
name str: Dynamic secret name
target_name str: Name of existing target to use in dynamic secret creation
token_permissions Sequence[str]: Tokens' allowed permissions. By default use installation allowed permissions. Input format: key=value pairs or JSON strings, e.g - -p contents=read -p issues=write or -p '{content:read}'
token_repositories Sequence[str]: Tokens' allowed repositories. By default use installation allowed repositories. To specify multiple repositories use argument multiple times: -r RepoName1 -r RepoName2

dynamicSecretGithubId String: The ID of this resource.
githubAppId Number: Github application id
githubAppPrivateKey String: Github application private key (base64 encoded key)
githubBaseUrl String: Github base url
installationId Number: Github application installation id
installationOrganization String: Instead of installation id, set a GitHub organization name
installationRepository String: Instead of installation id, set a GitHub repository '\n\n/\n\n'
name String: Dynamic secret name
targetName String: Name of existing target to use in dynamic secret creation
tokenPermissions List<String>: Tokens' allowed permissions. By default use installation allowed permissions. Input format: key=value pairs or JSON strings, e.g - -p contents=read -p issues=write or -p '{content:read}'
tokenRepositories List<String>: Tokens' allowed repositories. By default use installation allowed repositories. To specify multiple repositories use argument multiple times: -r RepoName1 -r RepoName2

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.

TypeScript
Python
Go
C#
Java
YAML

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,
        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,
        name: Optional[str] = None,
        target_name: Optional[str] = None,
        token_permissions: Optional[Sequence[str]] = None,
        token_repositories: Optional[Sequence[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:

DynamicSecretGithubId string: The ID of this resource.
GithubAppId double: Github application id
GithubAppPrivateKey string: Github application private key (base64 encoded key)
GithubBaseUrl string: Github base url
InstallationId double: Github application installation id
InstallationOrganization string: Instead of installation id, set a GitHub organization name
InstallationRepository string: Instead of installation id, set a GitHub repository '\n\n/\n\n'
Name string: Dynamic secret name
TargetName string: Name of existing target to use in dynamic secret creation
TokenPermissions List<string>: Tokens' allowed permissions. By default use installation allowed permissions. Input format: key=value pairs or JSON strings, e.g - -p contents=read -p issues=write or -p '{content:read}'
TokenRepositories List<string>: Tokens' allowed repositories. By default use installation allowed repositories. To specify multiple repositories use argument multiple times: -r RepoName1 -r RepoName2

DynamicSecretGithubId string: The ID of this resource.
GithubAppId float64: Github application id
GithubAppPrivateKey string: Github application private key (base64 encoded key)
GithubBaseUrl string: Github base url
InstallationId float64: Github application installation id
InstallationOrganization string: Instead of installation id, set a GitHub organization name
InstallationRepository string: Instead of installation id, set a GitHub repository '\n\n/\n\n'
Name string: Dynamic secret name
TargetName string: Name of existing target to use in dynamic secret creation
TokenPermissions []string: Tokens' allowed permissions. By default use installation allowed permissions. Input format: key=value pairs or JSON strings, e.g - -p contents=read -p issues=write or -p '{content:read}'
TokenRepositories []string: Tokens' allowed repositories. By default use installation allowed repositories. To specify multiple repositories use argument multiple times: -r RepoName1 -r RepoName2

dynamicSecretGithubId String: The ID of this resource.
githubAppId Double: Github application id
githubAppPrivateKey String: Github application private key (base64 encoded key)
githubBaseUrl String: Github base url
installationId Double: Github application installation id
installationOrganization String: Instead of installation id, set a GitHub organization name
installationRepository String: Instead of installation id, set a GitHub repository '\n\n/\n\n'
name String: Dynamic secret name
targetName String: Name of existing target to use in dynamic secret creation
tokenPermissions List<String>: Tokens' allowed permissions. By default use installation allowed permissions. Input format: key=value pairs or JSON strings, e.g - -p contents=read -p issues=write or -p '{content:read}'
tokenRepositories List<String>: Tokens' allowed repositories. By default use installation allowed repositories. To specify multiple repositories use argument multiple times: -r RepoName1 -r RepoName2

dynamicSecretGithubId string: The ID of this resource.
githubAppId number: Github application id
githubAppPrivateKey string: Github application private key (base64 encoded key)
githubBaseUrl string: Github base url
installationId number: Github application installation id
installationOrganization string: Instead of installation id, set a GitHub organization name
installationRepository string: Instead of installation id, set a GitHub repository '\n\n/\n\n'
name string: Dynamic secret name
targetName string: Name of existing target to use in dynamic secret creation
tokenPermissions string[]: Tokens' allowed permissions. By default use installation allowed permissions. Input format: key=value pairs or JSON strings, e.g - -p contents=read -p issues=write or -p '{content:read}'
tokenRepositories string[]: Tokens' allowed repositories. By default use installation allowed repositories. To specify multiple repositories use argument multiple times: -r RepoName1 -r RepoName2

dynamic_secret_github_id str: The ID of this resource.
github_app_id float: Github application id
github_app_private_key str: Github application private key (base64 encoded key)
github_base_url str: Github base url
installation_id float: Github application installation id
installation_organization str: Instead of installation id, set a GitHub organization name
installation_repository str: Instead of installation id, set a GitHub repository '\n\n/\n\n'
name str: Dynamic secret name
target_name str: Name of existing target to use in dynamic secret creation
token_permissions Sequence[str]: Tokens' allowed permissions. By default use installation allowed permissions. Input format: key=value pairs or JSON strings, e.g - -p contents=read -p issues=write or -p '{content:read}'
token_repositories Sequence[str]: Tokens' allowed repositories. By default use installation allowed repositories. To specify multiple repositories use argument multiple times: -r RepoName1 -r RepoName2

dynamicSecretGithubId String: The ID of this resource.
githubAppId Number: Github application id
githubAppPrivateKey String: Github application private key (base64 encoded key)
githubBaseUrl String: Github base url
installationId Number: Github application installation id
installationOrganization String: Instead of installation id, set a GitHub organization name
installationRepository String: Instead of installation id, set a GitHub repository '\n\n/\n\n'
name String: Dynamic secret name
targetName String: Name of existing target to use in dynamic secret creation
tokenPermissions List<String>: Tokens' allowed permissions. By default use installation allowed permissions. Input format: key=value pairs or JSON strings, e.g - -p contents=read -p issues=write or -p '{content:read}'
tokenRepositories List<String>: Tokens' allowed repositories. By default use installation allowed repositories. To specify multiple repositories use argument multiple times: -r RepoName1 -r RepoName2

Package Details

Repository: akeyless akeyless-community/terraform-provider-akeyless
License
Notes: This Pulumi package is based on the akeyless Terraform Provider.

akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community

akeyless-community/terraform-provider-akeyless

akeyless.DynamicSecretGithub

On this page

On this page

Create DynamicSecretGithub Resource

Constructor syntax

Parameters

Constructor example

DynamicSecretGithub Resource Properties

Inputs

Outputs

Look up Existing DynamicSecretGithub Resource

Package Details

On this page

On this page