Docs Packages
  1. Packages
  2. Port
  3. API Docs
  4. Scorecard
Port v2.0.13 published on Thursday, Jul 25, 2024 by port-labs
port-labs/pulumi-port

port.Scorecard

Explore with Pulumi AI

port logo
Port v2.0.13 published on Thursday, Jul 25, 2024 by port-labs
port-labs/pulumi-port

    This resource allows you to manage a scorecard.

    See the Port documentation for more information about scorecards.

    Create Scorecard Resource

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

    Constructor syntax

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

@overload
def Scorecard(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              blueprint: Optional[str] = None,
              identifier: Optional[str] = None,
              rules: Optional[Sequence[ScorecardRuleArgs]] = None,
              title: Optional[str] = None,
              levels: Optional[Sequence[ScorecardLevelArgs]] = None)
    func NewScorecard(ctx *Context, name string, args ScorecardArgs, opts ...ResourceOption) (*Scorecard, error)
    public Scorecard(string name, ScorecardArgs args, CustomResourceOptions? opts = null)
    public Scorecard(String name, ScorecardArgs args)
public Scorecard(String name, ScorecardArgs args, CustomResourceOptions options)

    type: port:Scorecard
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 ScorecardArgs
    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 ScorecardArgs
    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 ScorecardArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScorecardArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScorecardArgs
    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 scorecardResource = new Port.Scorecard("scorecardResource", new()
{
    Blueprint = "string",
    Identifier = "string",
    Rules = new[]
    {
        new Port.Inputs.ScorecardRuleArgs
        {
            Identifier = "string",
            Level = "string",
            Query = new Port.Inputs.ScorecardRuleQueryArgs
            {
                Combinator = "string",
                Conditions = new[]
                {
                    "string",
                },
            },
            Title = "string",
        },
    },
    Title = "string",
    Levels = new[]
    {
        new Port.Inputs.ScorecardLevelArgs
        {
            Color = "string",
            Title = "string",
        },
    },
});

    example, err := port.NewScorecard(ctx, "scorecardResource", &port.ScorecardArgs{
	Blueprint:  pulumi.String("string"),
	Identifier: pulumi.String("string"),
	Rules: port.ScorecardRuleArray{
		&port.ScorecardRuleArgs{
			Identifier: pulumi.String("string"),
			Level:      pulumi.String("string"),
			Query: &port.ScorecardRuleQueryArgs{
				Combinator: pulumi.String("string"),
				Conditions: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
			Title: pulumi.String("string"),
		},
	},
	Title: pulumi.String("string"),
	Levels: port.ScorecardLevelArray{
		&port.ScorecardLevelArgs{
			Color: pulumi.String("string"),
			Title: pulumi.String("string"),
		},
	},
})

    var scorecardResource = new Scorecard("scorecardResource", ScorecardArgs.builder()
    .blueprint("string")
    .identifier("string")
    .rules(ScorecardRuleArgs.builder()
        .identifier("string")
        .level("string")
        .query(ScorecardRuleQueryArgs.builder()
            .combinator("string")
            .conditions("string")
            .build())
        .title("string")
        .build())
    .title("string")
    .levels(ScorecardLevelArgs.builder()
        .color("string")
        .title("string")
        .build())
    .build());

    scorecard_resource = port.Scorecard("scorecardResource",
    blueprint="string",
    identifier="string",
    rules=[port.ScorecardRuleArgs(
        identifier="string",
        level="string",
        query=port.ScorecardRuleQueryArgs(
            combinator="string",
            conditions=["string"],
        ),
        title="string",
    )],
    title="string",
    levels=[port.ScorecardLevelArgs(
        color="string",
        title="string",
    )])

    const scorecardResource = new port.Scorecard("scorecardResource", {
    blueprint: "string",
    identifier: "string",
    rules: [{
        identifier: "string",
        level: "string",
        query: {
            combinator: "string",
            conditions: ["string"],
        },
        title: "string",
    }],
    title: "string",
    levels: [{
        color: "string",
        title: "string",
    }],
});

    type: port:Scorecard
properties:
    blueprint: string
    identifier: string
    levels:
        - color: string
          title: string
    rules:
        - identifier: string
          level: string
          query:
            combinator: string
            conditions:
                - string
          title: string
    title: string

    Scorecard Resource Properties

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

    Inputs

    The Scorecard resource accepts the following input properties:

    Blueprint string
    The blueprint of the scorecard
    Identifier string
    The identifier of the scorecard
    Rules List<port_labs.Port.Inputs.ScorecardRule>
    The rules of the scorecard
    Title string
    The title of the scorecard
    Levels List<port_labs.Port.Inputs.ScorecardLevel>
    The levels of the scorecard. This overrides the default levels (Basic, Bronze, Silver, Gold) if provided
    Blueprint string
    The blueprint of the scorecard
    Identifier string
    The identifier of the scorecard
    Rules []ScorecardRuleArgs
    The rules of the scorecard
    Title string
    The title of the scorecard
    Levels []ScorecardLevelArgs
    The levels of the scorecard. This overrides the default levels (Basic, Bronze, Silver, Gold) if provided
    blueprint String
    The blueprint of the scorecard
    identifier String
    The identifier of the scorecard
    rules List<ScorecardRule>
    The rules of the scorecard
    title String
    The title of the scorecard
    levels List<ScorecardLevel>
    The levels of the scorecard. This overrides the default levels (Basic, Bronze, Silver, Gold) if provided
    blueprint string
    The blueprint of the scorecard
    identifier string
    The identifier of the scorecard
    rules ScorecardRule[]
    The rules of the scorecard
    title string
    The title of the scorecard
    levels ScorecardLevel[]
    The levels of the scorecard. This overrides the default levels (Basic, Bronze, Silver, Gold) if provided
    blueprint str
    The blueprint of the scorecard
    identifier str
    The identifier of the scorecard
    rules Sequence[ScorecardRuleArgs]
    The rules of the scorecard
    title str
    The title of the scorecard
    levels Sequence[ScorecardLevelArgs]
    The levels of the scorecard. This overrides the default levels (Basic, Bronze, Silver, Gold) if provided
    blueprint String
    The blueprint of the scorecard
    identifier String
    The identifier of the scorecard
    rules List<Property Map>
    The rules of the scorecard
    title String
    The title of the scorecard
    levels List<Property Map>
    The levels of the scorecard. This overrides the default levels (Basic, Bronze, Silver, Gold) if provided

    Outputs

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

    CreatedAt string
    The creation date of the scorecard
    CreatedBy string
    The creator of the scorecard
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    The last update date of the scorecard
    UpdatedBy string
    The last updater of the scorecard
    CreatedAt string
    The creation date of the scorecard
    CreatedBy string
    The creator of the scorecard
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    The last update date of the scorecard
    UpdatedBy string
    The last updater of the scorecard
    createdAt String
    The creation date of the scorecard
    createdBy String
    The creator of the scorecard
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    The last update date of the scorecard
    updatedBy String
    The last updater of the scorecard
    createdAt string
    The creation date of the scorecard
    createdBy string
    The creator of the scorecard
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt string
    The last update date of the scorecard
    updatedBy string
    The last updater of the scorecard
    created_at str
    The creation date of the scorecard
    created_by str
    The creator of the scorecard
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at str
    The last update date of the scorecard
    updated_by str
    The last updater of the scorecard
    createdAt String
    The creation date of the scorecard
    createdBy String
    The creator of the scorecard
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    The last update date of the scorecard
    updatedBy String
    The last updater of the scorecard

    Look up Existing Scorecard Resource

    Get an existing Scorecard 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?: ScorecardState, opts?: CustomResourceOptions): Scorecard
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        blueprint: Optional[str] = None,
        created_at: Optional[str] = None,
        created_by: Optional[str] = None,
        identifier: Optional[str] = None,
        levels: Optional[Sequence[ScorecardLevelArgs]] = None,
        rules: Optional[Sequence[ScorecardRuleArgs]] = None,
        title: Optional[str] = None,
        updated_at: Optional[str] = None,
        updated_by: Optional[str] = None) -> Scorecard
    func GetScorecard(ctx *Context, name string, id IDInput, state *ScorecardState, opts ...ResourceOption) (*Scorecard, error)
    public static Scorecard Get(string name, Input<string> id, ScorecardState? state, CustomResourceOptions? opts = null)
    public static Scorecard get(String name, Output<String> id, ScorecardState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Blueprint string
    The blueprint of the scorecard
    CreatedAt string
    The creation date of the scorecard
    CreatedBy string
    The creator of the scorecard
    Identifier string
    The identifier of the scorecard
    Levels List<port_labs.Port.Inputs.ScorecardLevel>
    The levels of the scorecard. This overrides the default levels (Basic, Bronze, Silver, Gold) if provided
    Rules List<port_labs.Port.Inputs.ScorecardRule>
    The rules of the scorecard
    Title string
    The title of the scorecard
    UpdatedAt string
    The last update date of the scorecard
    UpdatedBy string
    The last updater of the scorecard
    Blueprint string
    The blueprint of the scorecard
    CreatedAt string
    The creation date of the scorecard
    CreatedBy string
    The creator of the scorecard
    Identifier string
    The identifier of the scorecard
    Levels []ScorecardLevelArgs
    The levels of the scorecard. This overrides the default levels (Basic, Bronze, Silver, Gold) if provided
    Rules []ScorecardRuleArgs
    The rules of the scorecard
    Title string
    The title of the scorecard
    UpdatedAt string
    The last update date of the scorecard
    UpdatedBy string
    The last updater of the scorecard
    blueprint String
    The blueprint of the scorecard
    createdAt String
    The creation date of the scorecard
    createdBy String
    The creator of the scorecard
    identifier String
    The identifier of the scorecard
    levels List<ScorecardLevel>
    The levels of the scorecard. This overrides the default levels (Basic, Bronze, Silver, Gold) if provided
    rules List<ScorecardRule>
    The rules of the scorecard
    title String
    The title of the scorecard
    updatedAt String
    The last update date of the scorecard
    updatedBy String
    The last updater of the scorecard
    blueprint string
    The blueprint of the scorecard
    createdAt string
    The creation date of the scorecard
    createdBy string
    The creator of the scorecard
    identifier string
    The identifier of the scorecard
    levels ScorecardLevel[]
    The levels of the scorecard. This overrides the default levels (Basic, Bronze, Silver, Gold) if provided
    rules ScorecardRule[]
    The rules of the scorecard
    title string
    The title of the scorecard
    updatedAt string
    The last update date of the scorecard
    updatedBy string
    The last updater of the scorecard
    blueprint str
    The blueprint of the scorecard
    created_at str
    The creation date of the scorecard
    created_by str
    The creator of the scorecard
    identifier str
    The identifier of the scorecard
    levels Sequence[ScorecardLevelArgs]
    The levels of the scorecard. This overrides the default levels (Basic, Bronze, Silver, Gold) if provided
    rules Sequence[ScorecardRuleArgs]
    The rules of the scorecard
    title str
    The title of the scorecard
    updated_at str
    The last update date of the scorecard
    updated_by str
    The last updater of the scorecard
    blueprint String
    The blueprint of the scorecard
    createdAt String
    The creation date of the scorecard
    createdBy String
    The creator of the scorecard
    identifier String
    The identifier of the scorecard
    levels List<Property Map>
    The levels of the scorecard. This overrides the default levels (Basic, Bronze, Silver, Gold) if provided
    rules List<Property Map>
    The rules of the scorecard
    title String
    The title of the scorecard
    updatedAt String
    The last update date of the scorecard
    updatedBy String
    The last updater of the scorecard

    Supporting Types

    ScorecardLevel, ScorecardLevelArgs

    Color string
    The color of the level
    Title string
    The title of the level
    Color string
    The color of the level
    Title string
    The title of the level
    color String
    The color of the level
    title String
    The title of the level
    color string
    The color of the level
    title string
    The title of the level
    color str
    The color of the level
    title str
    The title of the level
    color String
    The color of the level
    title String
    The title of the level

    ScorecardRule, ScorecardRuleArgs

    Identifier string
    The identifier of the rule
    Level string
    The level of the rule
    Query port_labs.Port.Inputs.ScorecardRuleQuery
    The query of the rule
    Title string
    The title of the rule
    Identifier string
    The identifier of the rule
    Level string
    The level of the rule
    Query ScorecardRuleQuery
    The query of the rule
    Title string
    The title of the rule
    identifier String
    The identifier of the rule
    level String
    The level of the rule
    query ScorecardRuleQuery
    The query of the rule
    title String
    The title of the rule
    identifier string
    The identifier of the rule
    level string
    The level of the rule
    query ScorecardRuleQuery
    The query of the rule
    title string
    The title of the rule
    identifier str
    The identifier of the rule
    level str
    The level of the rule
    query ScorecardRuleQuery
    The query of the rule
    title str
    The title of the rule
    identifier String
    The identifier of the rule
    level String
    The level of the rule
    query Property Map
    The query of the rule
    title String
    The title of the rule

    ScorecardRuleQuery, ScorecardRuleQueryArgs

    Combinator string
    The combinator of the query
    Conditions List<string>
    The conditions of the query. Each condition object should be encoded to a string
    Combinator string
    The combinator of the query
    Conditions []string
    The conditions of the query. Each condition object should be encoded to a string
    combinator String
    The combinator of the query
    conditions List<String>
    The conditions of the query. Each condition object should be encoded to a string
    combinator string
    The combinator of the query
    conditions string[]
    The conditions of the query. Each condition object should be encoded to a string
    combinator str
    The combinator of the query
    conditions Sequence[str]
    The conditions of the query. Each condition object should be encoded to a string
    combinator String
    The combinator of the query
    conditions List<String>
    The conditions of the query. Each condition object should be encoded to a string

    Package Details

    Repository
    port port-labs/pulumi-port
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the port-labs Terraform Provider.
    port logo
    Port v2.0.13 published on Thursday, Jul 25, 2024 by port-labs
    port-labs/pulumi-port