1. Registry
  2. Packages
  3. Akeyless Provider
  4. API Docs
  5. TargetGithub
Viewing docs for akeyless 2.1.0
published on Thursday, Nov 19, 2026 by akeyless-community
akeyless
Viewing docs for akeyless 2.1.0
published on Thursday, Nov 19, 2026 by akeyless-community

    Github Target resource

    Create TargetGithub Resource

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

    Constructor syntax

    new TargetGithub(name: string, args?: TargetGithubArgs, opts?: CustomResourceOptions);
    @overload
    def TargetGithub(resource_name: str,
                     args: Optional[TargetGithubArgs] = None,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def TargetGithub(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     description: Optional[str] = None,
                     github_app_id: Optional[float] = None,
                     github_app_private_key: Optional[str] = None,
                     github_base_url: Optional[str] = None,
                     keep_prev_version: Optional[str] = None,
                     key: Optional[str] = None,
                     max_versions: Optional[str] = None,
                     name: Optional[str] = None,
                     retry: Optional[TargetGithubRetryArgs] = None,
                     target_github_id: Optional[str] = None)
    func NewTargetGithub(ctx *Context, name string, args *TargetGithubArgs, opts ...ResourceOption) (*TargetGithub, error)
    public TargetGithub(string name, TargetGithubArgs? args = null, CustomResourceOptions? opts = null)
    public TargetGithub(String name, TargetGithubArgs args)
    public TargetGithub(String name, TargetGithubArgs args, CustomResourceOptions options)
    
    type: akeyless:TargetGithub
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "akeyless_target_github" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args TargetGithubArgs
    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 TargetGithubArgs
    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 TargetGithubArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TargetGithubArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TargetGithubArgs
    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 targetGithubResource = new Akeyless.TargetGithub("targetGithubResource", new()
    {
        Description = "string",
        GithubAppId = 0.0,
        GithubAppPrivateKey = "string",
        GithubBaseUrl = "string",
        KeepPrevVersion = "string",
        Key = "string",
        MaxVersions = "string",
        Name = "string",
        Retry = new Akeyless.Inputs.TargetGithubRetryArgs
        {
            ErrorMessageRegexes = new[]
            {
                "string",
            },
            IntervalSeconds = 0.0,
            MaxIntervalSeconds = 0.0,
            MaxRetries = 0.0,
            RetryOnStatusCodes = new[]
            {
                0.0,
            },
        },
        TargetGithubId = "string",
    });
    
    example, err := akeyless.NewTargetGithub(ctx, "targetGithubResource", &akeyless.TargetGithubArgs{
    	Description:         pulumi.String("string"),
    	GithubAppId:         pulumi.Float64(0),
    	GithubAppPrivateKey: pulumi.String("string"),
    	GithubBaseUrl:       pulumi.String("string"),
    	KeepPrevVersion:     pulumi.String("string"),
    	Key:                 pulumi.String("string"),
    	MaxVersions:         pulumi.String("string"),
    	Name:                pulumi.String("string"),
    	Retry: &akeyless.TargetGithubRetryArgs{
    		ErrorMessageRegexes: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		IntervalSeconds:    pulumi.Float64(0),
    		MaxIntervalSeconds: pulumi.Float64(0),
    		MaxRetries:         pulumi.Float64(0),
    		RetryOnStatusCodes: pulumi.Float64Array{
    			pulumi.Float64(0),
    		},
    	},
    	TargetGithubId: pulumi.String("string"),
    })
    
    resource "akeyless_target_github" "targetGithubResource" {
      lifecycle {
        create_before_destroy = true
      }
      description            = "string"
      github_app_id          = 0
      github_app_private_key = "string"
      github_base_url        = "string"
      keep_prev_version      = "string"
      key                    = "string"
      max_versions           = "string"
      name                   = "string"
      retry = {
        error_message_regexes = ["string"]
        interval_seconds      = 0
        max_interval_seconds  = 0
        max_retries           = 0
        retry_on_status_codes = [0]
      }
      target_github_id = "string"
    }
    
    var targetGithubResource = new TargetGithub("targetGithubResource", TargetGithubArgs.builder()
        .description("string")
        .githubAppId(0.0)
        .githubAppPrivateKey("string")
        .githubBaseUrl("string")
        .keepPrevVersion("string")
        .key("string")
        .maxVersions("string")
        .name("string")
        .retry(TargetGithubRetryArgs.builder()
            .errorMessageRegexes("string")
            .intervalSeconds(0.0)
            .maxIntervalSeconds(0.0)
            .maxRetries(0.0)
            .retryOnStatusCodes(0.0)
            .build())
        .targetGithubId("string")
        .build());
    
    target_github_resource = akeyless.TargetGithub("targetGithubResource",
        description="string",
        github_app_id=float(0),
        github_app_private_key="string",
        github_base_url="string",
        keep_prev_version="string",
        key="string",
        max_versions="string",
        name="string",
        retry={
            "error_message_regexes": ["string"],
            "interval_seconds": float(0),
            "max_interval_seconds": float(0),
            "max_retries": float(0),
            "retry_on_status_codes": [float(0)],
        },
        target_github_id="string")
    
    const targetGithubResource = new akeyless.TargetGithub("targetGithubResource", {
        description: "string",
        githubAppId: 0,
        githubAppPrivateKey: "string",
        githubBaseUrl: "string",
        keepPrevVersion: "string",
        key: "string",
        maxVersions: "string",
        name: "string",
        retry: {
            errorMessageRegexes: ["string"],
            intervalSeconds: 0,
            maxIntervalSeconds: 0,
            maxRetries: 0,
            retryOnStatusCodes: [0],
        },
        targetGithubId: "string",
    });
    
    type: akeyless:TargetGithub
    properties:
        description: string
        githubAppId: 0
        githubAppPrivateKey: string
        githubBaseUrl: string
        keepPrevVersion: string
        key: string
        maxVersions: string
        name: string
        retry:
            errorMessageRegexes:
                - string
            intervalSeconds: 0
            maxIntervalSeconds: 0
            maxRetries: 0
            retryOnStatusCodes:
                - 0
        targetGithubId: string
    

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

    Description string
    Description of the object
    GithubAppId double
    Github application id
    GithubAppPrivateKey string
    App private key
    GithubBaseUrl string
    Base URL
    KeepPrevVersion string
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    Key string
    The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
    MaxVersions string
    Set the maximum number of versions, limited by the account settings defaults
    Name string
    Target name
    Retry TargetGithubRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    TargetGithubId string
    The ID of this resource.
    Description string
    Description of the object
    GithubAppId float64
    Github application id
    GithubAppPrivateKey string
    App private key
    GithubBaseUrl string
    Base URL
    KeepPrevVersion string
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    Key string
    The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
    MaxVersions string
    Set the maximum number of versions, limited by the account settings defaults
    Name string
    Target name
    Retry TargetGithubRetryArgs
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    TargetGithubId string
    The ID of this resource.
    description string
    Description of the object
    github_app_id number
    Github application id
    github_app_private_key string
    App private key
    github_base_url string
    Base URL
    keep_prev_version string
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    key string
    The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
    max_versions string
    Set the maximum number of versions, limited by the account settings defaults
    name string
    Target name
    retry object
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    target_github_id string
    The ID of this resource.
    description String
    Description of the object
    githubAppId Double
    Github application id
    githubAppPrivateKey String
    App private key
    githubBaseUrl String
    Base URL
    keepPrevVersion String
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    key String
    The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
    maxVersions String
    Set the maximum number of versions, limited by the account settings defaults
    name String
    Target name
    retry TargetGithubRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    targetGithubId String
    The ID of this resource.
    description string
    Description of the object
    githubAppId number
    Github application id
    githubAppPrivateKey string
    App private key
    githubBaseUrl string
    Base URL
    keepPrevVersion string
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    key string
    The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
    maxVersions string
    Set the maximum number of versions, limited by the account settings defaults
    name string
    Target name
    retry TargetGithubRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    targetGithubId string
    The ID of this resource.
    description str
    Description of the object
    github_app_id float
    Github application id
    github_app_private_key str
    App private key
    github_base_url str
    Base URL
    keep_prev_version str
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    key str
    The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
    max_versions str
    Set the maximum number of versions, limited by the account settings defaults
    name str
    Target name
    retry TargetGithubRetryArgs
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    target_github_id str
    The ID of this resource.
    description String
    Description of the object
    githubAppId Number
    Github application id
    githubAppPrivateKey String
    App private key
    githubBaseUrl String
    Base URL
    keepPrevVersion String
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    key String
    The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
    maxVersions String
    Set the maximum number of versions, limited by the account settings defaults
    name String
    Target name
    retry Property Map
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    targetGithubId String
    The ID of this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TargetGithub 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 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 TargetGithub Resource

    Get an existing TargetGithub 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?: TargetGithubState, opts?: CustomResourceOptions): TargetGithub
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            github_app_id: Optional[float] = None,
            github_app_private_key: Optional[str] = None,
            github_base_url: Optional[str] = None,
            keep_prev_version: Optional[str] = None,
            key: Optional[str] = None,
            max_versions: Optional[str] = None,
            name: Optional[str] = None,
            retry: Optional[TargetGithubRetryArgs] = None,
            target_github_id: Optional[str] = None) -> TargetGithub
    func GetTargetGithub(ctx *Context, name string, id IDInput, state *TargetGithubState, opts ...ResourceOption) (*TargetGithub, error)
    public static TargetGithub Get(string name, Input<string> id, TargetGithubState? state, CustomResourceOptions? opts = null)
    public static TargetGithub get(String name, Output<String> id, TargetGithubState state, CustomResourceOptions options)
    resources:  existingTargetGithub:    type: akeyless:TargetGithub    get:      id: ${id}
    import {
      to = akeyless_target_github.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    state TargetGithubState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    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 resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state TargetGithubState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    state TargetGithubState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    state TargetGithubState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    options CustomResourceOptions
    Bag of options to control resource's behavior.
    The following state arguments are supported:
    Description string
    Description of the object
    GithubAppId double
    Github application id
    GithubAppPrivateKey string
    App private key
    GithubBaseUrl string
    Base URL
    KeepPrevVersion string
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    Key string
    The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
    MaxVersions string
    Set the maximum number of versions, limited by the account settings defaults
    Name string
    Target name
    Retry TargetGithubRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    TargetGithubId string
    The ID of this resource.
    Description string
    Description of the object
    GithubAppId float64
    Github application id
    GithubAppPrivateKey string
    App private key
    GithubBaseUrl string
    Base URL
    KeepPrevVersion string
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    Key string
    The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
    MaxVersions string
    Set the maximum number of versions, limited by the account settings defaults
    Name string
    Target name
    Retry TargetGithubRetryArgs
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    TargetGithubId string
    The ID of this resource.
    description string
    Description of the object
    github_app_id number
    Github application id
    github_app_private_key string
    App private key
    github_base_url string
    Base URL
    keep_prev_version string
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    key string
    The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
    max_versions string
    Set the maximum number of versions, limited by the account settings defaults
    name string
    Target name
    retry object
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    target_github_id string
    The ID of this resource.
    description String
    Description of the object
    githubAppId Double
    Github application id
    githubAppPrivateKey String
    App private key
    githubBaseUrl String
    Base URL
    keepPrevVersion String
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    key String
    The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
    maxVersions String
    Set the maximum number of versions, limited by the account settings defaults
    name String
    Target name
    retry TargetGithubRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    targetGithubId String
    The ID of this resource.
    description string
    Description of the object
    githubAppId number
    Github application id
    githubAppPrivateKey string
    App private key
    githubBaseUrl string
    Base URL
    keepPrevVersion string
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    key string
    The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
    maxVersions string
    Set the maximum number of versions, limited by the account settings defaults
    name string
    Target name
    retry TargetGithubRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    targetGithubId string
    The ID of this resource.
    description str
    Description of the object
    github_app_id float
    Github application id
    github_app_private_key str
    App private key
    github_base_url str
    Base URL
    keep_prev_version str
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    key str
    The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
    max_versions str
    Set the maximum number of versions, limited by the account settings defaults
    name str
    Target name
    retry TargetGithubRetryArgs
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    target_github_id str
    The ID of this resource.
    description String
    Description of the object
    githubAppId Number
    Github application id
    githubAppPrivateKey String
    App private key
    githubBaseUrl String
    Base URL
    keepPrevVersion String
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    key String
    The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
    maxVersions String
    Set the maximum number of versions, limited by the account settings defaults
    name String
    Target name
    retry Property Map
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    targetGithubId String
    The ID of this resource.

    Supporting Types

    TargetGithubRetry, TargetGithubRetryArgs

    ErrorMessageRegexes List<string>
    Regular expressions matched against the error message. If any matches, the operation is retried.
    IntervalSeconds double
    Wait before the first retry, in seconds. The wait doubles on each retry.
    MaxIntervalSeconds double
    Maximum wait between retries, in seconds.
    MaxRetries double
    Maximum number of retries after the first attempt.
    RetryOnStatusCodes List<double>
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    ErrorMessageRegexes []string
    Regular expressions matched against the error message. If any matches, the operation is retried.
    IntervalSeconds float64
    Wait before the first retry, in seconds. The wait doubles on each retry.
    MaxIntervalSeconds float64
    Maximum wait between retries, in seconds.
    MaxRetries float64
    Maximum number of retries after the first attempt.
    RetryOnStatusCodes []float64
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    error_message_regexes list(string)
    Regular expressions matched against the error message. If any matches, the operation is retried.
    interval_seconds number
    Wait before the first retry, in seconds. The wait doubles on each retry.
    max_interval_seconds number
    Maximum wait between retries, in seconds.
    max_retries number
    Maximum number of retries after the first attempt.
    retry_on_status_codes list(number)
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    errorMessageRegexes List<String>
    Regular expressions matched against the error message. If any matches, the operation is retried.
    intervalSeconds Double
    Wait before the first retry, in seconds. The wait doubles on each retry.
    maxIntervalSeconds Double
    Maximum wait between retries, in seconds.
    maxRetries Double
    Maximum number of retries after the first attempt.
    retryOnStatusCodes List<Double>
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    errorMessageRegexes string[]
    Regular expressions matched against the error message. If any matches, the operation is retried.
    intervalSeconds number
    Wait before the first retry, in seconds. The wait doubles on each retry.
    maxIntervalSeconds number
    Maximum wait between retries, in seconds.
    maxRetries number
    Maximum number of retries after the first attempt.
    retryOnStatusCodes number[]
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    error_message_regexes Sequence[str]
    Regular expressions matched against the error message. If any matches, the operation is retried.
    interval_seconds float
    Wait before the first retry, in seconds. The wait doubles on each retry.
    max_interval_seconds float
    Maximum wait between retries, in seconds.
    max_retries float
    Maximum number of retries after the first attempt.
    retry_on_status_codes Sequence[float]
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    errorMessageRegexes List<String>
    Regular expressions matched against the error message. If any matches, the operation is retried.
    intervalSeconds Number
    Wait before the first retry, in seconds. The wait doubles on each retry.
    maxIntervalSeconds Number
    Maximum wait between retries, in seconds.
    maxRetries Number
    Maximum number of retries after the first attempt.
    retryOnStatusCodes List<Number>
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    akeyless
    Viewing docs for akeyless 2.1.0
    published on Thursday, Nov 19, 2026 by akeyless-community

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial