1. Packages
  2. Github Provider
  3. API Docs
  4. ActionsOrganizationOidcSubjectClaimCustomizationTemplate
GitHub v6.3.2 published on Friday, Oct 11, 2024 by Pulumi

github.ActionsOrganizationOidcSubjectClaimCustomizationTemplate

Explore with Pulumi AI

github logo
GitHub v6.3.2 published on Friday, Oct 11, 2024 by Pulumi

    This resource allows you to create and manage an OpenID Connect subject claim customization template within a GitHub organization.

    More information on integrating GitHub with cloud providers using OpenID Connect and a list of available claims is available in the Actions documentation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as github from "@pulumi/github";
    
    const exampleTemplate = new github.ActionsOrganizationOidcSubjectClaimCustomizationTemplate("example_template", {includeClaimKeys: [
        "actor",
        "context",
        "repository_owner",
    ]});
    
    import pulumi
    import pulumi_github as github
    
    example_template = github.ActionsOrganizationOidcSubjectClaimCustomizationTemplate("example_template", include_claim_keys=[
        "actor",
        "context",
        "repository_owner",
    ])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-github/sdk/v6/go/github"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := github.NewActionsOrganizationOidcSubjectClaimCustomizationTemplate(ctx, "example_template", &github.ActionsOrganizationOidcSubjectClaimCustomizationTemplateArgs{
    			IncludeClaimKeys: pulumi.StringArray{
    				pulumi.String("actor"),
    				pulumi.String("context"),
    				pulumi.String("repository_owner"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Github = Pulumi.Github;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleTemplate = new Github.ActionsOrganizationOidcSubjectClaimCustomizationTemplate("example_template", new()
        {
            IncludeClaimKeys = new[]
            {
                "actor",
                "context",
                "repository_owner",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.github.ActionsOrganizationOidcSubjectClaimCustomizationTemplate;
    import com.pulumi.github.ActionsOrganizationOidcSubjectClaimCustomizationTemplateArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var exampleTemplate = new ActionsOrganizationOidcSubjectClaimCustomizationTemplate("exampleTemplate", ActionsOrganizationOidcSubjectClaimCustomizationTemplateArgs.builder()
                .includeClaimKeys(            
                    "actor",
                    "context",
                    "repository_owner")
                .build());
    
        }
    }
    
    resources:
      exampleTemplate:
        type: github:ActionsOrganizationOidcSubjectClaimCustomizationTemplate
        name: example_template
        properties:
          includeClaimKeys:
            - actor
            - context
            - repository_owner
    

    Create ActionsOrganizationOidcSubjectClaimCustomizationTemplate Resource

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

    Constructor syntax

    new ActionsOrganizationOidcSubjectClaimCustomizationTemplate(name: string, args: ActionsOrganizationOidcSubjectClaimCustomizationTemplateArgs, opts?: CustomResourceOptions);
    @overload
    def ActionsOrganizationOidcSubjectClaimCustomizationTemplate(resource_name: str,
                                                                 args: ActionsOrganizationOidcSubjectClaimCustomizationTemplateArgs,
                                                                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def ActionsOrganizationOidcSubjectClaimCustomizationTemplate(resource_name: str,
                                                                 opts: Optional[ResourceOptions] = None,
                                                                 include_claim_keys: Optional[Sequence[str]] = None)
    func NewActionsOrganizationOidcSubjectClaimCustomizationTemplate(ctx *Context, name string, args ActionsOrganizationOidcSubjectClaimCustomizationTemplateArgs, opts ...ResourceOption) (*ActionsOrganizationOidcSubjectClaimCustomizationTemplate, error)
    public ActionsOrganizationOidcSubjectClaimCustomizationTemplate(string name, ActionsOrganizationOidcSubjectClaimCustomizationTemplateArgs args, CustomResourceOptions? opts = null)
    public ActionsOrganizationOidcSubjectClaimCustomizationTemplate(String name, ActionsOrganizationOidcSubjectClaimCustomizationTemplateArgs args)
    public ActionsOrganizationOidcSubjectClaimCustomizationTemplate(String name, ActionsOrganizationOidcSubjectClaimCustomizationTemplateArgs args, CustomResourceOptions options)
    
    type: github:ActionsOrganizationOidcSubjectClaimCustomizationTemplate
    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 ActionsOrganizationOidcSubjectClaimCustomizationTemplateArgs
    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 ActionsOrganizationOidcSubjectClaimCustomizationTemplateArgs
    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 ActionsOrganizationOidcSubjectClaimCustomizationTemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ActionsOrganizationOidcSubjectClaimCustomizationTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ActionsOrganizationOidcSubjectClaimCustomizationTemplateArgs
    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 actionsOrganizationOidcSubjectClaimCustomizationTemplateResource = new Github.ActionsOrganizationOidcSubjectClaimCustomizationTemplate("actionsOrganizationOidcSubjectClaimCustomizationTemplateResource", new()
    {
        IncludeClaimKeys = new[]
        {
            "string",
        },
    });
    
    example, err := github.NewActionsOrganizationOidcSubjectClaimCustomizationTemplate(ctx, "actionsOrganizationOidcSubjectClaimCustomizationTemplateResource", &github.ActionsOrganizationOidcSubjectClaimCustomizationTemplateArgs{
    	IncludeClaimKeys: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var actionsOrganizationOidcSubjectClaimCustomizationTemplateResource = new ActionsOrganizationOidcSubjectClaimCustomizationTemplate("actionsOrganizationOidcSubjectClaimCustomizationTemplateResource", ActionsOrganizationOidcSubjectClaimCustomizationTemplateArgs.builder()
        .includeClaimKeys("string")
        .build());
    
    actions_organization_oidc_subject_claim_customization_template_resource = github.ActionsOrganizationOidcSubjectClaimCustomizationTemplate("actionsOrganizationOidcSubjectClaimCustomizationTemplateResource", include_claim_keys=["string"])
    
    const actionsOrganizationOidcSubjectClaimCustomizationTemplateResource = new github.ActionsOrganizationOidcSubjectClaimCustomizationTemplate("actionsOrganizationOidcSubjectClaimCustomizationTemplateResource", {includeClaimKeys: ["string"]});
    
    type: github:ActionsOrganizationOidcSubjectClaimCustomizationTemplate
    properties:
        includeClaimKeys:
            - string
    

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

    IncludeClaimKeys List<string>
    A list of OpenID Connect claims.
    IncludeClaimKeys []string
    A list of OpenID Connect claims.
    includeClaimKeys List<String>
    A list of OpenID Connect claims.
    includeClaimKeys string[]
    A list of OpenID Connect claims.
    include_claim_keys Sequence[str]
    A list of OpenID Connect claims.
    includeClaimKeys List<String>
    A list of OpenID Connect claims.

    Outputs

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

    Get an existing ActionsOrganizationOidcSubjectClaimCustomizationTemplate 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?: ActionsOrganizationOidcSubjectClaimCustomizationTemplateState, opts?: CustomResourceOptions): ActionsOrganizationOidcSubjectClaimCustomizationTemplate
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            include_claim_keys: Optional[Sequence[str]] = None) -> ActionsOrganizationOidcSubjectClaimCustomizationTemplate
    func GetActionsOrganizationOidcSubjectClaimCustomizationTemplate(ctx *Context, name string, id IDInput, state *ActionsOrganizationOidcSubjectClaimCustomizationTemplateState, opts ...ResourceOption) (*ActionsOrganizationOidcSubjectClaimCustomizationTemplate, error)
    public static ActionsOrganizationOidcSubjectClaimCustomizationTemplate Get(string name, Input<string> id, ActionsOrganizationOidcSubjectClaimCustomizationTemplateState? state, CustomResourceOptions? opts = null)
    public static ActionsOrganizationOidcSubjectClaimCustomizationTemplate get(String name, Output<String> id, ActionsOrganizationOidcSubjectClaimCustomizationTemplateState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    IncludeClaimKeys List<string>
    A list of OpenID Connect claims.
    IncludeClaimKeys []string
    A list of OpenID Connect claims.
    includeClaimKeys List<String>
    A list of OpenID Connect claims.
    includeClaimKeys string[]
    A list of OpenID Connect claims.
    include_claim_keys Sequence[str]
    A list of OpenID Connect claims.
    includeClaimKeys List<String>
    A list of OpenID Connect claims.

    Import

    This resource can be imported using the organization’s name.

    $ pulumi import github:index/actionsOrganizationOidcSubjectClaimCustomizationTemplate:ActionsOrganizationOidcSubjectClaimCustomizationTemplate test example_organization
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    GitHub pulumi/pulumi-github
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the github Terraform Provider.
    github logo
    GitHub v6.3.2 published on Friday, Oct 11, 2024 by Pulumi