# SecretSyncCircleci

> Resource SecretSyncCircleci in pulumi-infisical.

<!-- Generated from the pulumi-infisical SDK. -->

Resource SecretSyncCircleci in pulumi-infisical.

Pulumi type: `infisical:index/secretSyncCircleci:SecretSyncCircleci`.

`name` is the Pulumi resource name. Nested object fields are documented under that object. They are not arguments of this resource.

## Example

Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.

```ts
import * as infisical from "pulumi-infisical"

const resource = new infisical.SecretSyncCircleci("secretSyncCircleci", {
  connectionId: "<connectionId>",
  destinationConfig: {
    orgName: "<orgName>",
    projectId: "<projectId>",
    projectName: "<projectName>",
  },
  environment: "<environment>",
  projectId: "<projectId>",
  secretPath: "<secretPath>",
  syncOptions: {
    initialSyncBehavior: "overwrite-destination",
  },
})
```

## Arguments

| Property            | Type                                          | Required | Description                                                                                      |
| ------------------- | --------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------ |
| `autoSyncEnabled`   | `boolean`                                     | no       | Whether secrets should be automatically synced when changes occur at the source location or not. |
| `connectionId`      | `string`                                      | yes      | The ID of the circleci Connection to use for syncing.                                            |
| `description`       | `string`                                      | no       | An optional description for the CircleCI sync.                                                   |
| `destinationConfig` | `SecretSyncCircleciDestinationConfig (input)` | yes      | The destination configuration for the secret sync.                                               |
| `environment`       | `string`                                      | yes      | The slug of the project environment to sync secrets from.                                        |
| `name`              | `string`                                      | no       | The name of the CircleCI sync to create. Must be slug-friendly.                                  |
| `projectId`         | `string`                                      | yes      | The ID of the Infisical project to create the sync in.                                           |
| `secretPath`        | `string`                                      | yes      | The folder path to sync secrets from.                                                            |
| `syncOptions`       | `SecretSyncCircleciSyncOptions (input)`       | yes      | Parameters to modify how secrets are synced.                                                     |

## Outputs

Computed outputs are produced by the provider. They are not constructor arguments.

| Property            | Type                                           | Computed | Description                                                                                      |
| ------------------- | ---------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------ |
| `autoSyncEnabled`   | `boolean`                                      | no       | Whether secrets should be automatically synced when changes occur at the source location or not. |
| `connectionId`      | `string`                                       | no       | The ID of the circleci Connection to use for syncing.                                            |
| `description`       | `string`                                       | no       | An optional description for the CircleCI sync.                                                   |
| `destinationConfig` | `SecretSyncCircleciDestinationConfig (output)` | no       | The destination configuration for the secret sync.                                               |
| `environment`       | `string`                                       | no       | The slug of the project environment to sync secrets from.                                        |
| `name`              | `string`                                       | no       | The name of the CircleCI sync to create. Must be slug-friendly.                                  |
| `projectId`         | `string`                                       | no       | The ID of the Infisical project to create the sync in.                                           |
| `secretPath`        | `string`                                       | no       | The folder path to sync secrets from.                                                            |
| `syncOptions`       | `SecretSyncCircleciSyncOptions (output)`       | no       | Parameters to modify how secrets are synced.                                                     |

## `SecretSyncCircleciDestinationConfig (input)`

Input object `SecretSyncCircleciDestinationConfig`. Fields below belong to this object, not to the parent.

| Property      | Type     | Required | Description                                               |
| ------------- | -------- | -------- | --------------------------------------------------------- |
| `orgName`     | `string` | yes      | The name of the CircleCI organization to sync secrets to. |
| `projectId`   | `string` | yes      | The ID of the CircleCI project to sync secrets to.        |
| `projectName` | `string` | yes      | The name of the CircleCI project to sync secrets to.      |

## `SecretSyncCircleciSyncOptions (input)`

Input object `SecretSyncCircleciSyncOptions`. Fields below belong to this object, not to the parent.

| Property                | Type      | Required | Description                                                                                                                                               |
| ----------------------- | --------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `disableSecretDeletion` | `boolean` | no       | When set to true, Infisical will not remove secrets from CircleCI. Enable this option if you intend to manage some secrets manually outside of Infisical. |
| `initialSyncBehavior`   | `string`  | yes      | Specify how Infisical should resolve the initial sync to the destination. Supported options: overwrite-destination                                        |
| `keySchema`             | `string`  | no       | The format to use for structuring secret keys in the CircleCI destination.                                                                                |

## `SecretSyncCircleciDestinationConfig (output)`

Output object `SecretSyncCircleciDestinationConfig`. Fields below belong to this object.

| Property      | Type     | Always present | Description                                               |
| ------------- | -------- | -------------- | --------------------------------------------------------- |
| `orgName`     | `string` | yes            | The name of the CircleCI organization to sync secrets to. |
| `projectId`   | `string` | yes            | The ID of the CircleCI project to sync secrets to.        |
| `projectName` | `string` | yes            | The name of the CircleCI project to sync secrets to.      |

## `SecretSyncCircleciSyncOptions (output)`

Output object `SecretSyncCircleciSyncOptions`. Fields below belong to this object.

| Property                | Type      | Always present | Description                                                                                                                                               |
| ----------------------- | --------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `disableSecretDeletion` | `boolean` | yes            | When set to true, Infisical will not remove secrets from CircleCI. Enable this option if you intend to manage some secrets manually outside of Infisical. |
| `initialSyncBehavior`   | `string`  | yes            | Specify how Infisical should resolve the initial sync to the destination. Supported options: overwrite-destination                                        |
| `keySchema`             | `string`  | no             | The format to use for structuring secret keys in the CircleCI destination.                                                                                |