github.DependabotOrganizationSecret
Explore with Pulumi AI
Example Usage
Create DependabotOrganizationSecret Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DependabotOrganizationSecret(name: string, args: DependabotOrganizationSecretArgs, opts?: CustomResourceOptions);
@overload
def DependabotOrganizationSecret(resource_name: str,
args: DependabotOrganizationSecretArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DependabotOrganizationSecret(resource_name: str,
opts: Optional[ResourceOptions] = None,
secret_name: Optional[str] = None,
visibility: Optional[str] = None,
encrypted_value: Optional[str] = None,
plaintext_value: Optional[str] = None,
selected_repository_ids: Optional[Sequence[int]] = None)
func NewDependabotOrganizationSecret(ctx *Context, name string, args DependabotOrganizationSecretArgs, opts ...ResourceOption) (*DependabotOrganizationSecret, error)
public DependabotOrganizationSecret(string name, DependabotOrganizationSecretArgs args, CustomResourceOptions? opts = null)
public DependabotOrganizationSecret(String name, DependabotOrganizationSecretArgs args)
public DependabotOrganizationSecret(String name, DependabotOrganizationSecretArgs args, CustomResourceOptions options)
type: github:DependabotOrganizationSecret
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 DependabotOrganizationSecretArgs
- 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 DependabotOrganizationSecretArgs
- 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 DependabotOrganizationSecretArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DependabotOrganizationSecretArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DependabotOrganizationSecretArgs
- 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 dependabotOrganizationSecretResource = new Github.DependabotOrganizationSecret("dependabotOrganizationSecretResource", new()
{
SecretName = "string",
Visibility = "string",
EncryptedValue = "string",
PlaintextValue = "string",
SelectedRepositoryIds = new[]
{
0,
},
});
example, err := github.NewDependabotOrganizationSecret(ctx, "dependabotOrganizationSecretResource", &github.DependabotOrganizationSecretArgs{
SecretName: pulumi.String("string"),
Visibility: pulumi.String("string"),
EncryptedValue: pulumi.String("string"),
PlaintextValue: pulumi.String("string"),
SelectedRepositoryIds: pulumi.IntArray{
pulumi.Int(0),
},
})
var dependabotOrganizationSecretResource = new DependabotOrganizationSecret("dependabotOrganizationSecretResource", DependabotOrganizationSecretArgs.builder()
.secretName("string")
.visibility("string")
.encryptedValue("string")
.plaintextValue("string")
.selectedRepositoryIds(0)
.build());
dependabot_organization_secret_resource = github.DependabotOrganizationSecret("dependabotOrganizationSecretResource",
secret_name="string",
visibility="string",
encrypted_value="string",
plaintext_value="string",
selected_repository_ids=[0])
const dependabotOrganizationSecretResource = new github.DependabotOrganizationSecret("dependabotOrganizationSecretResource", {
secretName: "string",
visibility: "string",
encryptedValue: "string",
plaintextValue: "string",
selectedRepositoryIds: [0],
});
type: github:DependabotOrganizationSecret
properties:
encryptedValue: string
plaintextValue: string
secretName: string
selectedRepositoryIds:
- 0
visibility: string
DependabotOrganizationSecret Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The DependabotOrganizationSecret resource accepts the following input properties:
- Secret
Name string - Name of the secret
- Visibility string
- Configures the access that repositories have to the organization secret.
Must be one of
all
,private
,selected
.selected_repository_ids
is required if set toselected
. - Encrypted
Value string - Encrypted value of the secret using the GitHub public key in Base64 format.
- Plaintext
Value string - Plaintext value of the secret to be encrypted
- Selected
Repository List<int>Ids - An array of repository ids that can access the organization secret.
- Secret
Name string - Name of the secret
- Visibility string
- Configures the access that repositories have to the organization secret.
Must be one of
all
,private
,selected
.selected_repository_ids
is required if set toselected
. - Encrypted
Value string - Encrypted value of the secret using the GitHub public key in Base64 format.
- Plaintext
Value string - Plaintext value of the secret to be encrypted
- Selected
Repository []intIds - An array of repository ids that can access the organization secret.
- secret
Name String - Name of the secret
- visibility String
- Configures the access that repositories have to the organization secret.
Must be one of
all
,private
,selected
.selected_repository_ids
is required if set toselected
. - encrypted
Value String - Encrypted value of the secret using the GitHub public key in Base64 format.
- plaintext
Value String - Plaintext value of the secret to be encrypted
- selected
Repository List<Integer>Ids - An array of repository ids that can access the organization secret.
- secret
Name string - Name of the secret
- visibility string
- Configures the access that repositories have to the organization secret.
Must be one of
all
,private
,selected
.selected_repository_ids
is required if set toselected
. - encrypted
Value string - Encrypted value of the secret using the GitHub public key in Base64 format.
- plaintext
Value string - Plaintext value of the secret to be encrypted
- selected
Repository number[]Ids - An array of repository ids that can access the organization secret.
- secret_
name str - Name of the secret
- visibility str
- Configures the access that repositories have to the organization secret.
Must be one of
all
,private
,selected
.selected_repository_ids
is required if set toselected
. - encrypted_
value str - Encrypted value of the secret using the GitHub public key in Base64 format.
- plaintext_
value str - Plaintext value of the secret to be encrypted
- selected_
repository_ Sequence[int]ids - An array of repository ids that can access the organization secret.
- secret
Name String - Name of the secret
- visibility String
- Configures the access that repositories have to the organization secret.
Must be one of
all
,private
,selected
.selected_repository_ids
is required if set toselected
. - encrypted
Value String - Encrypted value of the secret using the GitHub public key in Base64 format.
- plaintext
Value String - Plaintext value of the secret to be encrypted
- selected
Repository List<Number>Ids - An array of repository ids that can access the organization secret.
Outputs
All input properties are implicitly available as output properties. Additionally, the DependabotOrganizationSecret resource produces the following output properties:
- created_
at str - Date of dependabot_secret creation.
- id str
- The provider-assigned unique ID for this managed resource.
- updated_
at str - Date of dependabot_secret update.
Look up Existing DependabotOrganizationSecret Resource
Get an existing DependabotOrganizationSecret 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?: DependabotOrganizationSecretState, opts?: CustomResourceOptions): DependabotOrganizationSecret
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
created_at: Optional[str] = None,
encrypted_value: Optional[str] = None,
plaintext_value: Optional[str] = None,
secret_name: Optional[str] = None,
selected_repository_ids: Optional[Sequence[int]] = None,
updated_at: Optional[str] = None,
visibility: Optional[str] = None) -> DependabotOrganizationSecret
func GetDependabotOrganizationSecret(ctx *Context, name string, id IDInput, state *DependabotOrganizationSecretState, opts ...ResourceOption) (*DependabotOrganizationSecret, error)
public static DependabotOrganizationSecret Get(string name, Input<string> id, DependabotOrganizationSecretState? state, CustomResourceOptions? opts = null)
public static DependabotOrganizationSecret get(String name, Output<String> id, DependabotOrganizationSecretState 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.
- Created
At string - Date of dependabot_secret creation.
- Encrypted
Value string - Encrypted value of the secret using the GitHub public key in Base64 format.
- Plaintext
Value string - Plaintext value of the secret to be encrypted
- Secret
Name string - Name of the secret
- Selected
Repository List<int>Ids - An array of repository ids that can access the organization secret.
- Updated
At string - Date of dependabot_secret update.
- Visibility string
- Configures the access that repositories have to the organization secret.
Must be one of
all
,private
,selected
.selected_repository_ids
is required if set toselected
.
- Created
At string - Date of dependabot_secret creation.
- Encrypted
Value string - Encrypted value of the secret using the GitHub public key in Base64 format.
- Plaintext
Value string - Plaintext value of the secret to be encrypted
- Secret
Name string - Name of the secret
- Selected
Repository []intIds - An array of repository ids that can access the organization secret.
- Updated
At string - Date of dependabot_secret update.
- Visibility string
- Configures the access that repositories have to the organization secret.
Must be one of
all
,private
,selected
.selected_repository_ids
is required if set toselected
.
- created
At String - Date of dependabot_secret creation.
- encrypted
Value String - Encrypted value of the secret using the GitHub public key in Base64 format.
- plaintext
Value String - Plaintext value of the secret to be encrypted
- secret
Name String - Name of the secret
- selected
Repository List<Integer>Ids - An array of repository ids that can access the organization secret.
- updated
At String - Date of dependabot_secret update.
- visibility String
- Configures the access that repositories have to the organization secret.
Must be one of
all
,private
,selected
.selected_repository_ids
is required if set toselected
.
- created
At string - Date of dependabot_secret creation.
- encrypted
Value string - Encrypted value of the secret using the GitHub public key in Base64 format.
- plaintext
Value string - Plaintext value of the secret to be encrypted
- secret
Name string - Name of the secret
- selected
Repository number[]Ids - An array of repository ids that can access the organization secret.
- updated
At string - Date of dependabot_secret update.
- visibility string
- Configures the access that repositories have to the organization secret.
Must be one of
all
,private
,selected
.selected_repository_ids
is required if set toselected
.
- created_
at str - Date of dependabot_secret creation.
- encrypted_
value str - Encrypted value of the secret using the GitHub public key in Base64 format.
- plaintext_
value str - Plaintext value of the secret to be encrypted
- secret_
name str - Name of the secret
- selected_
repository_ Sequence[int]ids - An array of repository ids that can access the organization secret.
- updated_
at str - Date of dependabot_secret update.
- visibility str
- Configures the access that repositories have to the organization secret.
Must be one of
all
,private
,selected
.selected_repository_ids
is required if set toselected
.
- created
At String - Date of dependabot_secret creation.
- encrypted
Value String - Encrypted value of the secret using the GitHub public key in Base64 format.
- plaintext
Value String - Plaintext value of the secret to be encrypted
- secret
Name String - Name of the secret
- selected
Repository List<Number>Ids - An array of repository ids that can access the organization secret.
- updated
At String - Date of dependabot_secret update.
- visibility String
- Configures the access that repositories have to the organization secret.
Must be one of
all
,private
,selected
.selected_repository_ids
is required if set toselected
.
Import
This resource can be imported using an ID made up of the secret name:
$ pulumi import github:index/dependabotOrganizationSecret:DependabotOrganizationSecret test_secret test_secret_name
NOTE: the implementation is limited in that it won’t fetch the value of the
plaintext_value
or encrypted_value
fields when importing. You may need to ignore changes for these as a workaround.
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.