Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Athenz Provider
  3. API Docs
  4. Service
athenz 1.0.45 published on Tuesday, Apr 15, 2025 by athenz
athenz/terraform-provider-athenz

athenz.Service

Explore with Pulumi AI

athenz logo
athenz 1.0.45 published on Tuesday, Apr 15, 2025 by athenz
athenz/terraform-provider-athenz

    athenz.Service provides an Athenz service resource.

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.athenz.Service;
import com.pulumi.athenz.ServiceArgs;
import com.pulumi.athenz.inputs.ServicePublicKeyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var fooService = new Service("fooService", ServiceArgs.builder()
            .auditRef("create service")
            .domain("some_domain")
            .publicKeys(ServicePublicKeyArgs.builder()
                .key_id("v0")
                .key_value("""
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzZCUhLc3TpvObhjdY8Hb
/0zkfWAYSXLXaC9O1S8AXoM7/L70XY+9KL+1Iy7xYDTrbZB0tcolLwnnWHq5giZm
Uw3u6FGSl5ld4xpyqB02iK+cFSqS7KOLLH0p9gXRfxXiaqRiV2rKF0ThzrGox2cm
Df/QoZllNdwIFGqkuRcEDvBnRTLWlEVV+1U12fyEsA1yvVb4F9RscZDYmiPRbhA+
cLzqHKxX51dl6ek1x7AvUIM8js6WPIEfelyTRiUzXwOgIZbqvRHSPmFG0ZgZDjG3
Llfy/E8K0QtCk3ki1y8Tga2I5k2hffx3DrHMnr14Zj3Br0T9RwiqJD7FoyTiD/ti
xQIDAQAB
-----END PUBLIC KEY-----

                """)
                .build())
            .build());

    }
}

    resources:
  fooService:
    type: athenz:Service
    properties:
      auditRef: create service
      domain: some_domain
      publicKeys:
        - key_id: v0
          key_value: |+
            -----BEGIN PUBLIC KEY-----
            MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzZCUhLc3TpvObhjdY8Hb
            /0zkfWAYSXLXaC9O1S8AXoM7/L70XY+9KL+1Iy7xYDTrbZB0tcolLwnnWHq5giZm
            Uw3u6FGSl5ld4xpyqB02iK+cFSqS7KOLLH0p9gXRfxXiaqRiV2rKF0ThzrGox2cm
            Df/QoZllNdwIFGqkuRcEDvBnRTLWlEVV+1U12fyEsA1yvVb4F9RscZDYmiPRbhA+
            cLzqHKxX51dl6ek1x7AvUIM8js6WPIEfelyTRiUzXwOgIZbqvRHSPmFG0ZgZDjG3
            Llfy/E8K0QtCk3ki1y8Tga2I5k2hffx3DrHMnr14Zj3Br0T9RwiqJD7FoyTiD/ti
            xQIDAQAB
            -----END PUBLIC KEY-----

    Create Service Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Service(name: string, args: ServiceArgs, opts?: CustomResourceOptions);
    @overload
def Service(resource_name: str,
            args: ServiceArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Service(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            domain: Optional[str] = None,
            audit_ref: Optional[str] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            public_keys: Optional[Sequence[ServicePublicKeyArgs]] = None,
            service_id: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None)
    func NewService(ctx *Context, name string, args ServiceArgs, opts ...ResourceOption) (*Service, error)
    public Service(string name, ServiceArgs args, CustomResourceOptions? opts = null)
    public Service(String name, ServiceArgs args)
public Service(String name, ServiceArgs args, CustomResourceOptions options)

    type: athenz:Service
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 ServiceArgs
    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 ServiceArgs
    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 ServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceArgs
    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 serviceResource = new Athenz.Service("serviceResource", new()
{
    Domain = "string",
    AuditRef = "string",
    Description = "string",
    Name = "string",
    PublicKeys = new[]
    {
        new Athenz.Inputs.ServicePublicKeyArgs
        {
            KeyId = "string",
            KeyValue = "string",
        },
    },
    ServiceId = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := athenz.NewService(ctx, "serviceResource", &athenz.ServiceArgs{
Domain: pulumi.String("string"),
AuditRef: pulumi.String("string"),
Description: pulumi.String("string"),
Name: pulumi.String("string"),
PublicKeys: .ServicePublicKeyArray{
&.ServicePublicKeyArgs{
KeyId: pulumi.String("string"),
KeyValue: pulumi.String("string"),
},
},
ServiceId: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})

    var serviceResource = new Service("serviceResource", ServiceArgs.builder()
    .domain("string")
    .auditRef("string")
    .description("string")
    .name("string")
    .publicKeys(ServicePublicKeyArgs.builder()
        .keyId("string")
        .keyValue("string")
        .build())
    .serviceId("string")
    .tags(Map.of("string", "string"))
    .build());

    service_resource = athenz.Service("serviceResource",
    domain="string",
    audit_ref="string",
    description="string",
    name="string",
    public_keys=[{
        "key_id": "string",
        "key_value": "string",
    }],
    service_id="string",
    tags={
        "string": "string",
    })

    const serviceResource = new athenz.Service("serviceResource", {
    domain: "string",
    auditRef: "string",
    description: "string",
    name: "string",
    publicKeys: [{
        keyId: "string",
        keyValue: "string",
    }],
    serviceId: "string",
    tags: {
        string: "string",
    },
});

    type: athenz:Service
properties:
    auditRef: string
    description: string
    domain: string
    name: string
    publicKeys:
        - keyId: string
          keyValue: string
    serviceId: string
    tags:
        string: string

    Service 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 Service resource accepts the following input properties:

    Domain string
    Name of the domain that service belongs to
    AuditRef string
    string containing audit specification or ticket number.
    Description string
    A description of the service
    Name string
    Name of the service to be added to the domain
    PublicKeys List<ServicePublicKey>
    • Set of maps of public keys
    ServiceId string
    The ID of this resource.
    Tags Dictionary<string, string>
    Domain string
    Name of the domain that service belongs to
    AuditRef string
    string containing audit specification or ticket number.
    Description string
    A description of the service
    Name string
    Name of the service to be added to the domain
    PublicKeys []ServicePublicKeyArgs
    • Set of maps of public keys
    ServiceId string
    The ID of this resource.
    Tags map[string]string
    domain String
    Name of the domain that service belongs to
    auditRef String
    string containing audit specification or ticket number.
    description String
    A description of the service
    name String
    Name of the service to be added to the domain
    publicKeys List<ServicePublicKey>
    • Set of maps of public keys
    serviceId String
    The ID of this resource.
    tags Map<String,String>
    domain string
    Name of the domain that service belongs to
    auditRef string
    string containing audit specification or ticket number.
    description string
    A description of the service
    name string
    Name of the service to be added to the domain
    publicKeys ServicePublicKey[]
    • Set of maps of public keys
    serviceId string
    The ID of this resource.
    tags {[key: string]: string}
    domain str
    Name of the domain that service belongs to
    audit_ref str
    string containing audit specification or ticket number.
    description str
    A description of the service
    name str
    Name of the service to be added to the domain
    public_keys Sequence[ServicePublicKeyArgs]
    • Set of maps of public keys
    service_id str
    The ID of this resource.
    tags Mapping[str, str]
    domain String
    Name of the domain that service belongs to
    auditRef String
    string containing audit specification or ticket number.
    description String
    A description of the service
    name String
    Name of the service to be added to the domain
    publicKeys List<Property Map>
    • Set of maps of public keys
    serviceId String
    The ID of this resource.
    tags Map<String>

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Service Resource

    Get an existing Service 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?: ServiceState, opts?: CustomResourceOptions): Service
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        audit_ref: Optional[str] = None,
        description: Optional[str] = None,
        domain: Optional[str] = None,
        name: Optional[str] = None,
        public_keys: Optional[Sequence[ServicePublicKeyArgs]] = None,
        service_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> Service
    func GetService(ctx *Context, name string, id IDInput, state *ServiceState, opts ...ResourceOption) (*Service, error)
    public static Service Get(string name, Input<string> id, ServiceState? state, CustomResourceOptions? opts = null)
    public static Service get(String name, Output<String> id, ServiceState state, CustomResourceOptions options)
    resources:  _:    type: athenz:Service    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.
    The following state arguments are supported:
    AuditRef string
    string containing audit specification or ticket number.
    Description string
    A description of the service
    Domain string
    Name of the domain that service belongs to
    Name string
    Name of the service to be added to the domain
    PublicKeys List<ServicePublicKey>
    • Set of maps of public keys
    ServiceId string
    The ID of this resource.
    Tags Dictionary<string, string>
    AuditRef string
    string containing audit specification or ticket number.
    Description string
    A description of the service
    Domain string
    Name of the domain that service belongs to
    Name string
    Name of the service to be added to the domain
    PublicKeys []ServicePublicKeyArgs
    • Set of maps of public keys
    ServiceId string
    The ID of this resource.
    Tags map[string]string
    auditRef String
    string containing audit specification or ticket number.
    description String
    A description of the service
    domain String
    Name of the domain that service belongs to
    name String
    Name of the service to be added to the domain
    publicKeys List<ServicePublicKey>
    • Set of maps of public keys
    serviceId String
    The ID of this resource.
    tags Map<String,String>
    auditRef string
    string containing audit specification or ticket number.
    description string
    A description of the service
    domain string
    Name of the domain that service belongs to
    name string
    Name of the service to be added to the domain
    publicKeys ServicePublicKey[]
    • Set of maps of public keys
    serviceId string
    The ID of this resource.
    tags {[key: string]: string}
    audit_ref str
    string containing audit specification or ticket number.
    description str
    A description of the service
    domain str
    Name of the domain that service belongs to
    name str
    Name of the service to be added to the domain
    public_keys Sequence[ServicePublicKeyArgs]
    • Set of maps of public keys
    service_id str
    The ID of this resource.
    tags Mapping[str, str]
    auditRef String
    string containing audit specification or ticket number.
    description String
    A description of the service
    domain String
    Name of the domain that service belongs to
    name String
    Name of the service to be added to the domain
    publicKeys List<Property Map>
    • Set of maps of public keys
    serviceId String
    The ID of this resource.
    tags Map<String>

    Supporting Types

    ServicePublicKey, ServicePublicKeyArgs

    KeyId string
    • The key id.
    KeyValue string
    • The Key Value which must be a PEM encoded public key.
    KeyId string
    • The key id.
    KeyValue string
    • The Key Value which must be a PEM encoded public key.
    keyId String
    • The key id.
    keyValue String
    • The Key Value which must be a PEM encoded public key.
    keyId string
    • The key id.
    keyValue string
    • The Key Value which must be a PEM encoded public key.
    key_id str
    • The key id.
    key_value str
    • The Key Value which must be a PEM encoded public key.
    keyId String
    • The key id.
    keyValue String
    • The Key Value which must be a PEM encoded public key.

    Package Details

    Repository
    athenz athenz/terraform-provider-athenz
    License
    Notes
    This Pulumi package is based on the athenz Terraform Provider.
    athenz logo
    athenz 1.0.45 published on Tuesday, Apr 15, 2025 by athenz
    athenz/terraform-provider-athenz