package nitric.proto.resources.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Nitric Resource Service The service definition exists to allow a nitric application to declare peripheral dependencies

• rpc Declare (ResourceDeclareRequest, ResourceDeclareResponse)

  resources.proto:18

  Declare a resource for the nitric application At Deploy time this will create resources as part of the nitric stacks dependency graph At runtime

  message ResourceDeclareRequest

  resources.proto:55

  • optional ResourceIdentifier id = 1

  • oneof config

    • PolicyResource policy = 10

    • BucketResource bucket = 11

    • TopicResource topic = 12

    • KeyValueStoreResource key_value_store = 13

    • SecretResource secret = 14

    • ApiResource api = 15

    • ApiSecurityDefinitionResource api_security_definition = 16

    • QueueResource queue = 17

    • SqlDatabaseResource sql_database = 18

    • JobResource job = 19

  message ResourceDeclareResponse

  resources.proto:152

  (message has no fields)

Used in: deployments.v1.Policy, PolicyResource

• BucketFileList = 0

  Bucket Permissions: 0XX

• BucketFileGet = 1

• BucketFilePut = 2

• BucketFileDelete = 3

• TopicPublish = 200

  Topic Permissions: 2XX

• KeyValueStoreRead = 300

  KeyValue Store Permissions: 3XX

• KeyValueStoreWrite = 301

• KeyValueStoreDelete = 302

• SecretPut = 400

  Secret Permissions: 4XX

• SecretAccess = 401

• WebsocketManage = 500

  Websocket Permissions: 5XX

• QueueEnqueue = 600

  Queue Permissions: 6XX

• QueueDequeue = 601

• JobSubmit = 700

  Job Permissions: 7XX

Used in: ApiSecurityDefinitionResource

• string issuer = 1

• repeated string audiences = 2

Used in: ResourceDeclareRequest

• map<string, ApiScopes> security = 1

  root level security map for this api references ApiSecurityDefinitionResource(s)

Used in: ApiResource

• repeated string scopes = 1

Used in: ResourceDeclareRequest

• string api_name = 1

• oneof definition

  • ApiOpenIdConnectionDefinition oidc = 2

Used in: ResourceDeclareRequest

(message has no fields)

Used in: ResourceDeclareRequest

(message has no fields)

Used in: ResourceDeclareRequest

(message has no fields)

Used in: ResourceDeclareRequest

• repeated ResourceIdentifier principals = 1

• repeated Action actions = 2

• repeated ResourceIdentifier resources = 3

Used in: ResourceDeclareRequest

(message has no fields)

Unique identifier for a resource within a nitric application.

Used in: deployments.v1.Resource, deployments.v1.ResourceUpdate, PolicyResource, ResourceDeclareRequest

• ResourceType type = 1

• string name = 2

Used in: ResourceIdentifier

• Api = 0

• Service = 1

• Bucket = 2

• Topic = 3

• Schedule = 4

• Subscription = 5

• KeyValueStore = 6

• Policy = 7

• Secret = 8

• BucketListener = 9

• Websocket = 10

• Http = 11

• ApiSecurityDefinition = 12

• Queue = 13

• SqlDatabase = 14

• Batch = 15

  Batches represent a collection of jobs

• Job = 16

• Website = 17

Used in: ResourceDeclareRequest

(message has no fields)

Used in: SqlDatabaseResource

• oneof migrations

  • string migrations_path = 1

    The path to this databases SQL migrations Valid values are file://relative/path/to/migrations as a directory or dockerfile://path/to/migrations.dockerfile to hint at a docker image build Paths should be relative to the root of the application (nitric.yaml file location)

Used in: ResourceDeclareRequest

• optional SqlDatabaseMigrations migrations = 1

Used in: ResourceDeclareRequest

(message has no fields)