ActionsRepositoryOidcSubjectClaimCustomizationTemplate

This resource allows you to create and manage an OpenID Connect subject claim customization template for a GitHub repository. More information on integrating GitHub with cloud providers using OpenID Connect and a list of available claims is available in the Actions documentation. The following table lists the behaviour of use_default: | use_default | include_claim_keys | Template used | |---------------|----------------------|-----------------------------------------------------------| | true | Unset | GitHub's default | | false | Set | include_claim_keys | | false | Unset | Organization's default if set, otherwise GitHub's default |

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
const example = new github.Repository("example", {name: "example-repository"});
const exampleTemplate = new github.ActionsRepositoryOidcSubjectClaimCustomizationTemplate("example_template", {
repository: example.name,
useDefault: false,
includeClaimKeys: [
"actor",
"context",
"repository_owner",
],
});
import pulumi
import pulumi_github as github
example = github.Repository("example", name="example-repository")
example_template = github.ActionsRepositoryOidcSubjectClaimCustomizationTemplate("example_template",
repository=example.name,
use_default=False,
include_claim_keys=[
"actor",
"context",
"repository_owner",
])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;
return await Deployment.RunAsync(() =>
{
var example = new Github.Repository("example", new()
{
Name = "example-repository",
});
var exampleTemplate = new Github.ActionsRepositoryOidcSubjectClaimCustomizationTemplate("example_template", new()
{
Repository = example.Name,
UseDefault = false,
IncludeClaimKeys = new[]
{
"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 {
example, err := github.NewRepository(ctx, "example", &github.RepositoryArgs{
Name: pulumi.String("example-repository"),
})
if err != nil {
return err
}
_, err = github.NewActionsRepositoryOidcSubjectClaimCustomizationTemplate(ctx, "example_template", &github.ActionsRepositoryOidcSubjectClaimCustomizationTemplateArgs{
Repository: example.Name,
UseDefault: pulumi.Bool(false),
IncludeClaimKeys: pulumi.StringArray{
pulumi.String("actor"),
pulumi.String("context"),
pulumi.String("repository_owner"),
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.github.Repository;
import com.pulumi.github.RepositoryArgs;
import com.pulumi.github.ActionsRepositoryOidcSubjectClaimCustomizationTemplate;
import com.pulumi.github.ActionsRepositoryOidcSubjectClaimCustomizationTemplateArgs;
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 example = new Repository("example", RepositoryArgs.builder()
.name("example-repository")
.build());
var exampleTemplate = new ActionsRepositoryOidcSubjectClaimCustomizationTemplate("exampleTemplate", ActionsRepositoryOidcSubjectClaimCustomizationTemplateArgs.builder()
.repository(example.name())
.useDefault(false)
.includeClaimKeys(
"actor",
"context",
"repository_owner")
.build());
}
}
resources:
example:
type: github:Repository
properties:
name: example-repository
exampleTemplate:
type: github:ActionsRepositoryOidcSubjectClaimCustomizationTemplate
name: example_template
properties:
repository: ${example.name}
useDefault: false
includeClaimKeys:
- actor
- context
- repository_owner

Import

This resource can be imported using the repository's name.

$ pulumi import github:index/actionsRepositoryOidcSubjectClaimCustomizationTemplate:ActionsRepositoryOidcSubjectClaimCustomizationTemplate test example_repository

Properties

Link copied to clipboard
val id: Output<String>
Link copied to clipboard

A list of OpenID Connect claims.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val repository: Output<String>

The name of the repository.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val useDefault: Output<Boolean>

Whether to use the default template or not. If true, include_claim_keys must not be set.