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.ProducerGithub

Explore with Pulumi AI

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

akeyless-community/terraform-provider-akeyless

Create ProducerGithub Resource

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

new ProducerGithub(name: string, args?: ProducerGithubArgs, opts?: CustomResourceOptions);

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

@overload
def ProducerGithub(resource_name: str,
                   opts: Optional[ResourceOptions] = 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_repository: Optional[str] = None,
                   name: Optional[str] = None,
                   producer_github_id: Optional[str] = None,
                   target_name: Optional[str] = None,
                   token_permissions: Optional[Sequence[str]] = None,
                   token_repositories: Optional[Sequence[str]] = None)

func NewProducerGithub(ctx *Context, name string, args *ProducerGithubArgs, opts ...ResourceOption) (*ProducerGithub, error)

public ProducerGithub(string name, ProducerGithubArgs? args = null, CustomResourceOptions? opts = null)

public ProducerGithub(String name, ProducerGithubArgs args)
public ProducerGithub(String name, ProducerGithubArgs args, CustomResourceOptions options)

type: akeyless:ProducerGithub
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 ProducerGithubArgs: 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 ProducerGithubArgs: 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 ProducerGithubArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args ProducerGithubArgs: 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 producerGithubResource = new Akeyless.ProducerGithub("producerGithubResource", new()
{
    GithubAppId = 0,
    GithubAppPrivateKey = "string",
    GithubBaseUrl = "string",
    InstallationId = 0,
    InstallationRepository = "string",
    Name = "string",
    ProducerGithubId = "string",
    TargetName = "string",
    TokenPermissions = new[]
    {
        "string",
    },
    TokenRepositories = new[]
    {
        "string",
    },
});

example, err := akeyless.NewProducerGithub(ctx, "producerGithubResource", &akeyless.ProducerGithubArgs{
	GithubAppId:            pulumi.Float64(0),
	GithubAppPrivateKey:    pulumi.String("string"),
	GithubBaseUrl:          pulumi.String("string"),
	InstallationId:         pulumi.Float64(0),
	InstallationRepository: pulumi.String("string"),
	Name:                   pulumi.String("string"),
	ProducerGithubId:       pulumi.String("string"),
	TargetName:             pulumi.String("string"),
	TokenPermissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	TokenRepositories: pulumi.StringArray{
		pulumi.String("string"),
	},
})

var producerGithubResource = new ProducerGithub("producerGithubResource", ProducerGithubArgs.builder()
    .githubAppId(0)
    .githubAppPrivateKey("string")
    .githubBaseUrl("string")
    .installationId(0)
    .installationRepository("string")
    .name("string")
    .producerGithubId("string")
    .targetName("string")
    .tokenPermissions("string")
    .tokenRepositories("string")
    .build());

producer_github_resource = akeyless.ProducerGithub("producerGithubResource",
    github_app_id=0,
    github_app_private_key="string",
    github_base_url="string",
    installation_id=0,
    installation_repository="string",
    name="string",
    producer_github_id="string",
    target_name="string",
    token_permissions=["string"],
    token_repositories=["string"])

const producerGithubResource = new akeyless.ProducerGithub("producerGithubResource", {
    githubAppId: 0,
    githubAppPrivateKey: "string",
    githubBaseUrl: "string",
    installationId: 0,
    installationRepository: "string",
    name: "string",
    producerGithubId: "string",
    targetName: "string",
    tokenPermissions: ["string"],
    tokenRepositories: ["string"],
});

type: akeyless:ProducerGithub
properties:
    githubAppId: 0
    githubAppPrivateKey: string
    githubBaseUrl: string
    installationId: 0
    installationRepository: string
    name: string
    producerGithubId: string
    targetName: string
    tokenPermissions:
        - string
    tokenRepositories:
        - string

ProducerGithub 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 ProducerGithub resource accepts the following input properties:

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
InstallationRepository string: Optional, instead of installation id, set a GitHub repository '\n\n/\n\n'
Name string: Producer name
ProducerGithubId string: The ID of this resource.
TargetName string: Name of existing target to use in producer 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

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
InstallationRepository string: Optional, instead of installation id, set a GitHub repository '\n\n/\n\n'
Name string: Producer name
ProducerGithubId string: The ID of this resource.
TargetName string: Name of existing target to use in producer 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

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
installationRepository String: Optional, instead of installation id, set a GitHub repository '\n\n/\n\n'
name String: Producer name
producerGithubId String: The ID of this resource.
targetName String: Name of existing target to use in producer 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

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
installationRepository string: Optional, instead of installation id, set a GitHub repository '\n\n/\n\n'
name string: Producer name
producerGithubId string: The ID of this resource.
targetName string: Name of existing target to use in producer 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

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_repository str: Optional, instead of installation id, set a GitHub repository '\n\n/\n\n'
name str: Producer name
producer_github_id str: The ID of this resource.
target_name str: Name of existing target to use in producer 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

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
installationRepository String: Optional, instead of installation id, set a GitHub repository '\n\n/\n\n'
name String: Producer name
producerGithubId String: The ID of this resource.
targetName String: Name of existing target to use in producer 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 ProducerGithub 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 ProducerGithub Resource

Get an existing ProducerGithub 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?: ProducerGithubState, opts?: CustomResourceOptions): ProducerGithub

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = 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_repository: Optional[str] = None,
        name: Optional[str] = None,
        producer_github_id: Optional[str] = None,
        target_name: Optional[str] = None,
        token_permissions: Optional[Sequence[str]] = None,
        token_repositories: Optional[Sequence[str]] = None) -> ProducerGithub

func GetProducerGithub(ctx *Context, name string, id IDInput, state *ProducerGithubState, opts ...ResourceOption) (*ProducerGithub, error)

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

public static ProducerGithub get(String name, Output<String> id, ProducerGithubState state, CustomResourceOptions options)

resources:  _:    type: akeyless:ProducerGithub    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:

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
InstallationRepository string: Optional, instead of installation id, set a GitHub repository '\n\n/\n\n'
Name string: Producer name
ProducerGithubId string: The ID of this resource.
TargetName string: Name of existing target to use in producer 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

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
InstallationRepository string: Optional, instead of installation id, set a GitHub repository '\n\n/\n\n'
Name string: Producer name
ProducerGithubId string: The ID of this resource.
TargetName string: Name of existing target to use in producer 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

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
installationRepository String: Optional, instead of installation id, set a GitHub repository '\n\n/\n\n'
name String: Producer name
producerGithubId String: The ID of this resource.
targetName String: Name of existing target to use in producer 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

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
installationRepository string: Optional, instead of installation id, set a GitHub repository '\n\n/\n\n'
name string: Producer name
producerGithubId string: The ID of this resource.
targetName string: Name of existing target to use in producer 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

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_repository str: Optional, instead of installation id, set a GitHub repository '\n\n/\n\n'
name str: Producer name
producer_github_id str: The ID of this resource.
target_name str: Name of existing target to use in producer 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

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
installationRepository String: Optional, instead of installation id, set a GitHub repository '\n\n/\n\n'
name String: Producer name
producerGithubId String: The ID of this resource.
targetName String: Name of existing target to use in producer 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.ProducerGithub

On this page

On this page

Create ProducerGithub Resource

Constructor syntax

Parameters

Constructor example

ProducerGithub Resource Properties

Inputs

Outputs

Look up Existing ProducerGithub Resource

Package Details

On this page

On this page