Endpoint

Import

Import is not supported for this resource.

Create a Endpoint Resource

new Endpoint(name: string, args: EndpointArgs, opts?: CustomResourceOptions);
@overload
def Endpoint(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             data_json: Optional[str] = None,
             disable_delete: Optional[bool] = None,
             disable_read: Optional[bool] = None,
             ignore_absent_fields: Optional[bool] = None,
             path: Optional[str] = None,
             write_fields: Optional[Sequence[str]] = None)
@overload
def Endpoint(resource_name: str,
             args: EndpointArgs,
             opts: Optional[ResourceOptions] = None)
func NewEndpoint(ctx *Context, name string, args EndpointArgs, opts ...ResourceOption) (*Endpoint, error)
public Endpoint(string name, EndpointArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args EndpointArgs
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 EndpointArgs
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 EndpointArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args EndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Endpoint Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Endpoint resource accepts the following input properties:

DataJson string
String containing a JSON-encoded object that will be written to the given path as the secret data.
Path string
The full logical path at which to write the given data. Consult each backend’s documentation to see which endpoints support the PUT methods and to determine whether they also support DELETE and GET.
DisableDelete bool
Don’t attempt to delete the path from Vault if true
DisableRead bool
True/false. Set this to true if your vault authentication is not able to read the data or if the endpoint does not support the GET method. Setting this to true will break drift detection. You should set this to true for endpoints that are write-only. Defaults to false.
IgnoreAbsentFields bool
When reading, disregard fields not present in data_json
WriteFields List<string>
Top-level fields returned by write to persist in state
DataJson string
String containing a JSON-encoded object that will be written to the given path as the secret data.
Path string
The full logical path at which to write the given data. Consult each backend’s documentation to see which endpoints support the PUT methods and to determine whether they also support DELETE and GET.
DisableDelete bool
Don’t attempt to delete the path from Vault if true
DisableRead bool
True/false. Set this to true if your vault authentication is not able to read the data or if the endpoint does not support the GET method. Setting this to true will break drift detection. You should set this to true for endpoints that are write-only. Defaults to false.
IgnoreAbsentFields bool
When reading, disregard fields not present in data_json
WriteFields []string
Top-level fields returned by write to persist in state
dataJson string
String containing a JSON-encoded object that will be written to the given path as the secret data.
path string
The full logical path at which to write the given data. Consult each backend’s documentation to see which endpoints support the PUT methods and to determine whether they also support DELETE and GET.
disableDelete boolean
Don’t attempt to delete the path from Vault if true
disableRead boolean
True/false. Set this to true if your vault authentication is not able to read the data or if the endpoint does not support the GET method. Setting this to true will break drift detection. You should set this to true for endpoints that are write-only. Defaults to false.
ignoreAbsentFields boolean
When reading, disregard fields not present in data_json
writeFields string[]
Top-level fields returned by write to persist in state
data_json str
String containing a JSON-encoded object that will be written to the given path as the secret data.
path str
The full logical path at which to write the given data. Consult each backend’s documentation to see which endpoints support the PUT methods and to determine whether they also support DELETE and GET.
disable_delete bool
Don’t attempt to delete the path from Vault if true
disable_read bool
True/false. Set this to true if your vault authentication is not able to read the data or if the endpoint does not support the GET method. Setting this to true will break drift detection. You should set this to true for endpoints that are write-only. Defaults to false.
ignore_absent_fields bool
When reading, disregard fields not present in data_json
write_fields Sequence[str]
Top-level fields returned by write to persist in state

Outputs

All input properties are implicitly available as output properties. Additionally, the Endpoint resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
WriteData Dictionary<string, string>
Map of strings returned by write operation
WriteDataJson string
JSON data returned by write operation
Id string
The provider-assigned unique ID for this managed resource.
WriteData map[string]string
Map of strings returned by write operation
WriteDataJson string
JSON data returned by write operation
id string
The provider-assigned unique ID for this managed resource.
writeData {[key: string]: string}
Map of strings returned by write operation
writeDataJson string
JSON data returned by write operation
id str
The provider-assigned unique ID for this managed resource.
write_data Mapping[str, str]
Map of strings returned by write operation
write_data_json str
JSON data returned by write operation

Look up an Existing Endpoint Resource

Get an existing Endpoint 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?: EndpointState, opts?: CustomResourceOptions): Endpoint
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        data_json: Optional[str] = None,
        disable_delete: Optional[bool] = None,
        disable_read: Optional[bool] = None,
        ignore_absent_fields: Optional[bool] = None,
        path: Optional[str] = None,
        write_data: Optional[Mapping[str, str]] = None,
        write_data_json: Optional[str] = None,
        write_fields: Optional[Sequence[str]] = None) -> Endpoint
func GetEndpoint(ctx *Context, name string, id IDInput, state *EndpointState, opts ...ResourceOption) (*Endpoint, error)
public static Endpoint Get(string name, Input<string> id, EndpointState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

DataJson string
String containing a JSON-encoded object that will be written to the given path as the secret data.
DisableDelete bool
Don’t attempt to delete the path from Vault if true
DisableRead bool
True/false. Set this to true if your vault authentication is not able to read the data or if the endpoint does not support the GET method. Setting this to true will break drift detection. You should set this to true for endpoints that are write-only. Defaults to false.
IgnoreAbsentFields bool
When reading, disregard fields not present in data_json
Path string
The full logical path at which to write the given data. Consult each backend’s documentation to see which endpoints support the PUT methods and to determine whether they also support DELETE and GET.
WriteData Dictionary<string, string>
Map of strings returned by write operation
WriteDataJson string
JSON data returned by write operation
WriteFields List<string>
Top-level fields returned by write to persist in state
DataJson string
String containing a JSON-encoded object that will be written to the given path as the secret data.
DisableDelete bool
Don’t attempt to delete the path from Vault if true
DisableRead bool
True/false. Set this to true if your vault authentication is not able to read the data or if the endpoint does not support the GET method. Setting this to true will break drift detection. You should set this to true for endpoints that are write-only. Defaults to false.
IgnoreAbsentFields bool
When reading, disregard fields not present in data_json
Path string
The full logical path at which to write the given data. Consult each backend’s documentation to see which endpoints support the PUT methods and to determine whether they also support DELETE and GET.
WriteData map[string]string
Map of strings returned by write operation
WriteDataJson string
JSON data returned by write operation
WriteFields []string
Top-level fields returned by write to persist in state
dataJson string
String containing a JSON-encoded object that will be written to the given path as the secret data.
disableDelete boolean
Don’t attempt to delete the path from Vault if true
disableRead boolean
True/false. Set this to true if your vault authentication is not able to read the data or if the endpoint does not support the GET method. Setting this to true will break drift detection. You should set this to true for endpoints that are write-only. Defaults to false.
ignoreAbsentFields boolean
When reading, disregard fields not present in data_json
path string
The full logical path at which to write the given data. Consult each backend’s documentation to see which endpoints support the PUT methods and to determine whether they also support DELETE and GET.
writeData {[key: string]: string}
Map of strings returned by write operation
writeDataJson string
JSON data returned by write operation
writeFields string[]
Top-level fields returned by write to persist in state
data_json str
String containing a JSON-encoded object that will be written to the given path as the secret data.
disable_delete bool
Don’t attempt to delete the path from Vault if true
disable_read bool
True/false. Set this to true if your vault authentication is not able to read the data or if the endpoint does not support the GET method. Setting this to true will break drift detection. You should set this to true for endpoints that are write-only. Defaults to false.
ignore_absent_fields bool
When reading, disregard fields not present in data_json
path str
The full logical path at which to write the given data. Consult each backend’s documentation to see which endpoints support the PUT methods and to determine whether they also support DELETE and GET.
write_data Mapping[str, str]
Map of strings returned by write operation
write_data_json str
JSON data returned by write operation
write_fields Sequence[str]
Top-level fields returned by write to persist in state

Package Details

Repository
https://github.com/pulumi/pulumi-vault
License
Apache-2.0
Notes
This Pulumi package is based on the vault Terraform Provider.