Import
Import Command
The following command imports a GitHub actions organization secret named mysecret to a github_actions_organization_secret resource named example.
$ pulumi import github:index/actionsOrganizationSecret:ActionsOrganizationSecret example mysecret
Create ActionsOrganizationSecret Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ActionsOrganizationSecret(name: string, args: ActionsOrganizationSecretArgs, opts?: CustomResourceOptions);@overload
def ActionsOrganizationSecret(resource_name: str,
args: ActionsOrganizationSecretArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ActionsOrganizationSecret(resource_name: str,
opts: Optional[ResourceOptions] = None,
secret_name: Optional[str] = None,
visibility: Optional[str] = None,
destroy_on_drift: Optional[bool] = None,
encrypted_value: Optional[str] = None,
key_id: Optional[str] = None,
plaintext_value: Optional[str] = None,
selected_repository_ids: Optional[Sequence[int]] = None)func NewActionsOrganizationSecret(ctx *Context, name string, args ActionsOrganizationSecretArgs, opts ...ResourceOption) (*ActionsOrganizationSecret, error)public ActionsOrganizationSecret(string name, ActionsOrganizationSecretArgs args, CustomResourceOptions? opts = null)
public ActionsOrganizationSecret(String name, ActionsOrganizationSecretArgs args)
public ActionsOrganizationSecret(String name, ActionsOrganizationSecretArgs args, CustomResourceOptions options)
type: github:ActionsOrganizationSecret
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 ActionsOrganizationSecretArgs
- 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 ActionsOrganizationSecretArgs
- 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 ActionsOrganizationSecretArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ActionsOrganizationSecretArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ActionsOrganizationSecretArgs
- 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 actionsOrganizationSecretResource = new Github.ActionsOrganizationSecret("actionsOrganizationSecretResource", new()
{
SecretName = "string",
Visibility = "string",
EncryptedValue = "string",
KeyId = "string",
PlaintextValue = "string",
});
example, err := github.NewActionsOrganizationSecret(ctx, "actionsOrganizationSecretResource", &github.ActionsOrganizationSecretArgs{
SecretName: pulumi.String("string"),
Visibility: pulumi.String("string"),
EncryptedValue: pulumi.String("string"),
KeyId: pulumi.String("string"),
PlaintextValue: pulumi.String("string"),
})
var actionsOrganizationSecretResource = new ActionsOrganizationSecret("actionsOrganizationSecretResource", ActionsOrganizationSecretArgs.builder()
.secretName("string")
.visibility("string")
.encryptedValue("string")
.keyId("string")
.plaintextValue("string")
.build());
actions_organization_secret_resource = github.ActionsOrganizationSecret("actionsOrganizationSecretResource",
secret_name="string",
visibility="string",
encrypted_value="string",
key_id="string",
plaintext_value="string")
const actionsOrganizationSecretResource = new github.ActionsOrganizationSecret("actionsOrganizationSecretResource", {
secretName: "string",
visibility: "string",
encryptedValue: "string",
keyId: "string",
plaintextValue: "string",
});
type: github:ActionsOrganizationSecret
properties:
encryptedValue: string
keyId: string
plaintextValue: string
secretName: string
visibility: string
ActionsOrganizationSecret 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 ActionsOrganizationSecret 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, orselected. - Destroy
On boolDrift (Optional) This is ignored as drift detection is built into the resource.
Note: One of either
encrypted_valueorplaintext_valuemust be specified.- Encrypted
Value string - Encrypted value of the secret using the GitHub public key in Base64 format.
- Key
Id string - ID of the public key used to encrypt the secret. This should be provided when setting
encrypted_value; if it isn't then the current public key will be looked up, which could cause a missmatch. This conflicts withplaintext_value. - 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 variable; this requires
visibilityto be set toselected.
- 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, orselected. - Destroy
On boolDrift (Optional) This is ignored as drift detection is built into the resource.
Note: One of either
encrypted_valueorplaintext_valuemust be specified.- Encrypted
Value string - Encrypted value of the secret using the GitHub public key in Base64 format.
- Key
Id string - ID of the public key used to encrypt the secret. This should be provided when setting
encrypted_value; if it isn't then the current public key will be looked up, which could cause a missmatch. This conflicts withplaintext_value. - Plaintext
Value string - Plaintext value of the secret to be encrypted.
- Selected
Repository []intIds - An array of repository IDs that can access the organization variable; this requires
visibilityto be set toselected.
- 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, orselected. - destroy
On BooleanDrift (Optional) This is ignored as drift detection is built into the resource.
Note: One of either
encrypted_valueorplaintext_valuemust be specified.- encrypted
Value String - Encrypted value of the secret using the GitHub public key in Base64 format.
- key
Id String - ID of the public key used to encrypt the secret. This should be provided when setting
encrypted_value; if it isn't then the current public key will be looked up, which could cause a missmatch. This conflicts withplaintext_value. - 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 variable; this requires
visibilityto be set toselected.
- 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, orselected. - destroy
On booleanDrift (Optional) This is ignored as drift detection is built into the resource.
Note: One of either
encrypted_valueorplaintext_valuemust be specified.- encrypted
Value string - Encrypted value of the secret using the GitHub public key in Base64 format.
- key
Id string - ID of the public key used to encrypt the secret. This should be provided when setting
encrypted_value; if it isn't then the current public key will be looked up, which could cause a missmatch. This conflicts withplaintext_value. - 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 variable; this requires
visibilityto be set toselected.
- 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, orselected. - destroy_
on_ booldrift (Optional) This is ignored as drift detection is built into the resource.
Note: One of either
encrypted_valueorplaintext_valuemust be specified.- encrypted_
value str - Encrypted value of the secret using the GitHub public key in Base64 format.
- key_
id str - ID of the public key used to encrypt the secret. This should be provided when setting
encrypted_value; if it isn't then the current public key will be looked up, which could cause a missmatch. This conflicts withplaintext_value. - 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 variable; this requires
visibilityto be set toselected.
- 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, orselected. - destroy
On BooleanDrift (Optional) This is ignored as drift detection is built into the resource.
Note: One of either
encrypted_valueorplaintext_valuemust be specified.- encrypted
Value String - Encrypted value of the secret using the GitHub public key in Base64 format.
- key
Id String - ID of the public key used to encrypt the secret. This should be provided when setting
encrypted_value; if it isn't then the current public key will be looked up, which could cause a missmatch. This conflicts withplaintext_value. - 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 variable; this requires
visibilityto be set toselected.
Outputs
All input properties are implicitly available as output properties. Additionally, the ActionsOrganizationSecret resource produces the following output properties:
- Created
At string - Date the secret was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Remote
Updated stringAt - Date the secret was last updated in GitHub.
- Updated
At string - Date the secret was last updated by the provider.
- Created
At string - Date the secret was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Remote
Updated stringAt - Date the secret was last updated in GitHub.
- Updated
At string - Date the secret was last updated by the provider.
- created
At String - Date the secret was created.
- id String
- The provider-assigned unique ID for this managed resource.
- remote
Updated StringAt - Date the secret was last updated in GitHub.
- updated
At String - Date the secret was last updated by the provider.
- created
At string - Date the secret was created.
- id string
- The provider-assigned unique ID for this managed resource.
- remote
Updated stringAt - Date the secret was last updated in GitHub.
- updated
At string - Date the secret was last updated by the provider.
- created_
at str - Date the secret was created.
- id str
- The provider-assigned unique ID for this managed resource.
- remote_
updated_ strat - Date the secret was last updated in GitHub.
- updated_
at str - Date the secret was last updated by the provider.
- created
At String - Date the secret was created.
- id String
- The provider-assigned unique ID for this managed resource.
- remote
Updated StringAt - Date the secret was last updated in GitHub.
- updated
At String - Date the secret was last updated by the provider.
Look up Existing ActionsOrganizationSecret Resource
Get an existing ActionsOrganizationSecret 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?: ActionsOrganizationSecretState, opts?: CustomResourceOptions): ActionsOrganizationSecret@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
created_at: Optional[str] = None,
destroy_on_drift: Optional[bool] = None,
encrypted_value: Optional[str] = None,
key_id: Optional[str] = None,
plaintext_value: Optional[str] = None,
remote_updated_at: Optional[str] = None,
secret_name: Optional[str] = None,
selected_repository_ids: Optional[Sequence[int]] = None,
updated_at: Optional[str] = None,
visibility: Optional[str] = None) -> ActionsOrganizationSecretfunc GetActionsOrganizationSecret(ctx *Context, name string, id IDInput, state *ActionsOrganizationSecretState, opts ...ResourceOption) (*ActionsOrganizationSecret, error)public static ActionsOrganizationSecret Get(string name, Input<string> id, ActionsOrganizationSecretState? state, CustomResourceOptions? opts = null)public static ActionsOrganizationSecret get(String name, Output<String> id, ActionsOrganizationSecretState state, CustomResourceOptions options)resources: _: type: github:ActionsOrganizationSecret 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.
- Created
At string - Date the secret was created.
- Destroy
On boolDrift (Optional) This is ignored as drift detection is built into the resource.
Note: One of either
encrypted_valueorplaintext_valuemust be specified.- Encrypted
Value string - Encrypted value of the secret using the GitHub public key in Base64 format.
- Key
Id string - ID of the public key used to encrypt the secret. This should be provided when setting
encrypted_value; if it isn't then the current public key will be looked up, which could cause a missmatch. This conflicts withplaintext_value. - Plaintext
Value string - Plaintext value of the secret to be encrypted.
- Remote
Updated stringAt - Date the secret was last updated in GitHub.
- Secret
Name string - Name of the secret.
- Selected
Repository List<int>Ids - An array of repository IDs that can access the organization variable; this requires
visibilityto be set toselected. - Updated
At string - Date the secret was last updated by the provider.
- Visibility string
- Configures the access that repositories have to the organization secret; must be one of
all,private, orselected.
- Created
At string - Date the secret was created.
- Destroy
On boolDrift (Optional) This is ignored as drift detection is built into the resource.
Note: One of either
encrypted_valueorplaintext_valuemust be specified.- Encrypted
Value string - Encrypted value of the secret using the GitHub public key in Base64 format.
- Key
Id string - ID of the public key used to encrypt the secret. This should be provided when setting
encrypted_value; if it isn't then the current public key will be looked up, which could cause a missmatch. This conflicts withplaintext_value. - Plaintext
Value string - Plaintext value of the secret to be encrypted.
- Remote
Updated stringAt - Date the secret was last updated in GitHub.
- Secret
Name string - Name of the secret.
- Selected
Repository []intIds - An array of repository IDs that can access the organization variable; this requires
visibilityto be set toselected. - Updated
At string - Date the secret was last updated by the provider.
- Visibility string
- Configures the access that repositories have to the organization secret; must be one of
all,private, orselected.
- created
At String - Date the secret was created.
- destroy
On BooleanDrift (Optional) This is ignored as drift detection is built into the resource.
Note: One of either
encrypted_valueorplaintext_valuemust be specified.- encrypted
Value String - Encrypted value of the secret using the GitHub public key in Base64 format.
- key
Id String - ID of the public key used to encrypt the secret. This should be provided when setting
encrypted_value; if it isn't then the current public key will be looked up, which could cause a missmatch. This conflicts withplaintext_value. - plaintext
Value String - Plaintext value of the secret to be encrypted.
- remote
Updated StringAt - Date the secret was last updated in GitHub.
- secret
Name String - Name of the secret.
- selected
Repository List<Integer>Ids - An array of repository IDs that can access the organization variable; this requires
visibilityto be set toselected. - updated
At String - Date the secret was last updated by the provider.
- visibility String
- Configures the access that repositories have to the organization secret; must be one of
all,private, orselected.
- created
At string - Date the secret was created.
- destroy
On booleanDrift (Optional) This is ignored as drift detection is built into the resource.
Note: One of either
encrypted_valueorplaintext_valuemust be specified.- encrypted
Value string - Encrypted value of the secret using the GitHub public key in Base64 format.
- key
Id string - ID of the public key used to encrypt the secret. This should be provided when setting
encrypted_value; if it isn't then the current public key will be looked up, which could cause a missmatch. This conflicts withplaintext_value. - plaintext
Value string - Plaintext value of the secret to be encrypted.
- remote
Updated stringAt - Date the secret was last updated in GitHub.
- secret
Name string - Name of the secret.
- selected
Repository number[]Ids - An array of repository IDs that can access the organization variable; this requires
visibilityto be set toselected. - updated
At string - Date the secret was last updated by the provider.
- visibility string
- Configures the access that repositories have to the organization secret; must be one of
all,private, orselected.
- created_
at str - Date the secret was created.
- destroy_
on_ booldrift (Optional) This is ignored as drift detection is built into the resource.
Note: One of either
encrypted_valueorplaintext_valuemust be specified.- encrypted_
value str - Encrypted value of the secret using the GitHub public key in Base64 format.
- key_
id str - ID of the public key used to encrypt the secret. This should be provided when setting
encrypted_value; if it isn't then the current public key will be looked up, which could cause a missmatch. This conflicts withplaintext_value. - plaintext_
value str - Plaintext value of the secret to be encrypted.
- remote_
updated_ strat - Date the secret was last updated in GitHub.
- secret_
name str - Name of the secret.
- selected_
repository_ Sequence[int]ids - An array of repository IDs that can access the organization variable; this requires
visibilityto be set toselected. - updated_
at str - Date the secret was last updated by the provider.
- visibility str
- Configures the access that repositories have to the organization secret; must be one of
all,private, orselected.
- created
At String - Date the secret was created.
- destroy
On BooleanDrift (Optional) This is ignored as drift detection is built into the resource.
Note: One of either
encrypted_valueorplaintext_valuemust be specified.- encrypted
Value String - Encrypted value of the secret using the GitHub public key in Base64 format.
- key
Id String - ID of the public key used to encrypt the secret. This should be provided when setting
encrypted_value; if it isn't then the current public key will be looked up, which could cause a missmatch. This conflicts withplaintext_value. - plaintext
Value String - Plaintext value of the secret to be encrypted.
- remote
Updated StringAt - Date the secret was last updated in GitHub.
- secret
Name String - Name of the secret.
- selected
Repository List<Number>Ids - An array of repository IDs that can access the organization variable; this requires
visibilityto be set toselected. - updated
At String - Date the secret was last updated by the provider.
- visibility String
- Configures the access that repositories have to the organization secret; must be one of
all,private, orselected.
Package Details
- Repository
- GitHub pulumi/pulumi-github
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
githubTerraform Provider.
