1. Packages
  2. Akamai
  3. API Docs
  4. PropertyInclude
Akamai v7.2.0 published on Friday, May 31, 2024 by Pulumi

akamai.PropertyInclude

Explore with Pulumi AI

akamai logo
Akamai v7.2.0 published on Friday, May 31, 2024 by Pulumi

    Create PropertyInclude Resource

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

    Constructor syntax

    new PropertyInclude(name: string, args: PropertyIncludeArgs, opts?: CustomResourceOptions);
    @overload
    def PropertyInclude(resource_name: str,
                        args: PropertyIncludeArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def PropertyInclude(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        contract_id: Optional[str] = None,
                        group_id: Optional[str] = None,
                        rule_format: Optional[str] = None,
                        type: Optional[str] = None,
                        name: Optional[str] = None,
                        product_id: Optional[str] = None,
                        rules: Optional[str] = None)
    func NewPropertyInclude(ctx *Context, name string, args PropertyIncludeArgs, opts ...ResourceOption) (*PropertyInclude, error)
    public PropertyInclude(string name, PropertyIncludeArgs args, CustomResourceOptions? opts = null)
    public PropertyInclude(String name, PropertyIncludeArgs args)
    public PropertyInclude(String name, PropertyIncludeArgs args, CustomResourceOptions options)
    
    type: akamai:PropertyInclude
    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 PropertyIncludeArgs
    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 PropertyIncludeArgs
    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 PropertyIncludeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PropertyIncludeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PropertyIncludeArgs
    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 propertyIncludeResource = new Akamai.PropertyInclude("propertyIncludeResource", new()
    {
        ContractId = "string",
        GroupId = "string",
        RuleFormat = "string",
        Type = "string",
        Name = "string",
        ProductId = "string",
        Rules = "string",
    });
    
    example, err := akamai.NewPropertyInclude(ctx, "propertyIncludeResource", &akamai.PropertyIncludeArgs{
    	ContractId: pulumi.String("string"),
    	GroupId:    pulumi.String("string"),
    	RuleFormat: pulumi.String("string"),
    	Type:       pulumi.String("string"),
    	Name:       pulumi.String("string"),
    	ProductId:  pulumi.String("string"),
    	Rules:      pulumi.String("string"),
    })
    
    var propertyIncludeResource = new PropertyInclude("propertyIncludeResource", PropertyIncludeArgs.builder()
        .contractId("string")
        .groupId("string")
        .ruleFormat("string")
        .type("string")
        .name("string")
        .productId("string")
        .rules("string")
        .build());
    
    property_include_resource = akamai.PropertyInclude("propertyIncludeResource",
        contract_id="string",
        group_id="string",
        rule_format="string",
        type="string",
        name="string",
        product_id="string",
        rules="string")
    
    const propertyIncludeResource = new akamai.PropertyInclude("propertyIncludeResource", {
        contractId: "string",
        groupId: "string",
        ruleFormat: "string",
        type: "string",
        name: "string",
        productId: "string",
        rules: "string",
    });
    
    type: akamai:PropertyInclude
    properties:
        contractId: string
        groupId: string
        name: string
        productId: string
        ruleFormat: string
        rules: string
        type: string
    

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

    ContractId string
    Identifies the contract to which the include is assigned
    GroupId string
    Identifies the group to which the include is assigned
    RuleFormat string
    Indicates the versioned set of features and criteria
    Type string
    Specifies the type of the include, either 'MICROSERVICES' or 'COMMON_SETTINGS'
    Name string
    A descriptive name for the include
    ProductId string
    The product assigned to the include
    Rules string
    Property Rules as JSON
    ContractId string
    Identifies the contract to which the include is assigned
    GroupId string
    Identifies the group to which the include is assigned
    RuleFormat string
    Indicates the versioned set of features and criteria
    Type string
    Specifies the type of the include, either 'MICROSERVICES' or 'COMMON_SETTINGS'
    Name string
    A descriptive name for the include
    ProductId string
    The product assigned to the include
    Rules string
    Property Rules as JSON
    contractId String
    Identifies the contract to which the include is assigned
    groupId String
    Identifies the group to which the include is assigned
    ruleFormat String
    Indicates the versioned set of features and criteria
    type String
    Specifies the type of the include, either 'MICROSERVICES' or 'COMMON_SETTINGS'
    name String
    A descriptive name for the include
    productId String
    The product assigned to the include
    rules String
    Property Rules as JSON
    contractId string
    Identifies the contract to which the include is assigned
    groupId string
    Identifies the group to which the include is assigned
    ruleFormat string
    Indicates the versioned set of features and criteria
    type string
    Specifies the type of the include, either 'MICROSERVICES' or 'COMMON_SETTINGS'
    name string
    A descriptive name for the include
    productId string
    The product assigned to the include
    rules string
    Property Rules as JSON
    contract_id str
    Identifies the contract to which the include is assigned
    group_id str
    Identifies the group to which the include is assigned
    rule_format str
    Indicates the versioned set of features and criteria
    type str
    Specifies the type of the include, either 'MICROSERVICES' or 'COMMON_SETTINGS'
    name str
    A descriptive name for the include
    product_id str
    The product assigned to the include
    rules str
    Property Rules as JSON
    contractId String
    Identifies the contract to which the include is assigned
    groupId String
    Identifies the group to which the include is assigned
    ruleFormat String
    Indicates the versioned set of features and criteria
    type String
    Specifies the type of the include, either 'MICROSERVICES' or 'COMMON_SETTINGS'
    name String
    A descriptive name for the include
    productId String
    The product assigned to the include
    rules String
    Property Rules as JSON

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    LatestVersion int
    Specifies the most recent version of the include
    ProductionVersion string
    The most recent version to be activated to the production network
    RuleErrors string
    Rule validation errors
    RuleWarnings string
    Rule validation warnings
    StagingVersion string
    The most recent version to be activated to the staging network
    Id string
    The provider-assigned unique ID for this managed resource.
    LatestVersion int
    Specifies the most recent version of the include
    ProductionVersion string
    The most recent version to be activated to the production network
    RuleErrors string
    Rule validation errors
    RuleWarnings string
    Rule validation warnings
    StagingVersion string
    The most recent version to be activated to the staging network
    id String
    The provider-assigned unique ID for this managed resource.
    latestVersion Integer
    Specifies the most recent version of the include
    productionVersion String
    The most recent version to be activated to the production network
    ruleErrors String
    Rule validation errors
    ruleWarnings String
    Rule validation warnings
    stagingVersion String
    The most recent version to be activated to the staging network
    id string
    The provider-assigned unique ID for this managed resource.
    latestVersion number
    Specifies the most recent version of the include
    productionVersion string
    The most recent version to be activated to the production network
    ruleErrors string
    Rule validation errors
    ruleWarnings string
    Rule validation warnings
    stagingVersion string
    The most recent version to be activated to the staging network
    id str
    The provider-assigned unique ID for this managed resource.
    latest_version int
    Specifies the most recent version of the include
    production_version str
    The most recent version to be activated to the production network
    rule_errors str
    Rule validation errors
    rule_warnings str
    Rule validation warnings
    staging_version str
    The most recent version to be activated to the staging network
    id String
    The provider-assigned unique ID for this managed resource.
    latestVersion Number
    Specifies the most recent version of the include
    productionVersion String
    The most recent version to be activated to the production network
    ruleErrors String
    Rule validation errors
    ruleWarnings String
    Rule validation warnings
    stagingVersion String
    The most recent version to be activated to the staging network

    Look up Existing PropertyInclude Resource

    Get an existing PropertyInclude 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?: PropertyIncludeState, opts?: CustomResourceOptions): PropertyInclude
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            contract_id: Optional[str] = None,
            group_id: Optional[str] = None,
            latest_version: Optional[int] = None,
            name: Optional[str] = None,
            product_id: Optional[str] = None,
            production_version: Optional[str] = None,
            rule_errors: Optional[str] = None,
            rule_format: Optional[str] = None,
            rule_warnings: Optional[str] = None,
            rules: Optional[str] = None,
            staging_version: Optional[str] = None,
            type: Optional[str] = None) -> PropertyInclude
    func GetPropertyInclude(ctx *Context, name string, id IDInput, state *PropertyIncludeState, opts ...ResourceOption) (*PropertyInclude, error)
    public static PropertyInclude Get(string name, Input<string> id, PropertyIncludeState? state, CustomResourceOptions? opts = null)
    public static PropertyInclude get(String name, Output<String> id, PropertyIncludeState 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:
    ContractId string
    Identifies the contract to which the include is assigned
    GroupId string
    Identifies the group to which the include is assigned
    LatestVersion int
    Specifies the most recent version of the include
    Name string
    A descriptive name for the include
    ProductId string
    The product assigned to the include
    ProductionVersion string
    The most recent version to be activated to the production network
    RuleErrors string
    Rule validation errors
    RuleFormat string
    Indicates the versioned set of features and criteria
    RuleWarnings string
    Rule validation warnings
    Rules string
    Property Rules as JSON
    StagingVersion string
    The most recent version to be activated to the staging network
    Type string
    Specifies the type of the include, either 'MICROSERVICES' or 'COMMON_SETTINGS'
    ContractId string
    Identifies the contract to which the include is assigned
    GroupId string
    Identifies the group to which the include is assigned
    LatestVersion int
    Specifies the most recent version of the include
    Name string
    A descriptive name for the include
    ProductId string
    The product assigned to the include
    ProductionVersion string
    The most recent version to be activated to the production network
    RuleErrors string
    Rule validation errors
    RuleFormat string
    Indicates the versioned set of features and criteria
    RuleWarnings string
    Rule validation warnings
    Rules string
    Property Rules as JSON
    StagingVersion string
    The most recent version to be activated to the staging network
    Type string
    Specifies the type of the include, either 'MICROSERVICES' or 'COMMON_SETTINGS'
    contractId String
    Identifies the contract to which the include is assigned
    groupId String
    Identifies the group to which the include is assigned
    latestVersion Integer
    Specifies the most recent version of the include
    name String
    A descriptive name for the include
    productId String
    The product assigned to the include
    productionVersion String
    The most recent version to be activated to the production network
    ruleErrors String
    Rule validation errors
    ruleFormat String
    Indicates the versioned set of features and criteria
    ruleWarnings String
    Rule validation warnings
    rules String
    Property Rules as JSON
    stagingVersion String
    The most recent version to be activated to the staging network
    type String
    Specifies the type of the include, either 'MICROSERVICES' or 'COMMON_SETTINGS'
    contractId string
    Identifies the contract to which the include is assigned
    groupId string
    Identifies the group to which the include is assigned
    latestVersion number
    Specifies the most recent version of the include
    name string
    A descriptive name for the include
    productId string
    The product assigned to the include
    productionVersion string
    The most recent version to be activated to the production network
    ruleErrors string
    Rule validation errors
    ruleFormat string
    Indicates the versioned set of features and criteria
    ruleWarnings string
    Rule validation warnings
    rules string
    Property Rules as JSON
    stagingVersion string
    The most recent version to be activated to the staging network
    type string
    Specifies the type of the include, either 'MICROSERVICES' or 'COMMON_SETTINGS'
    contract_id str
    Identifies the contract to which the include is assigned
    group_id str
    Identifies the group to which the include is assigned
    latest_version int
    Specifies the most recent version of the include
    name str
    A descriptive name for the include
    product_id str
    The product assigned to the include
    production_version str
    The most recent version to be activated to the production network
    rule_errors str
    Rule validation errors
    rule_format str
    Indicates the versioned set of features and criteria
    rule_warnings str
    Rule validation warnings
    rules str
    Property Rules as JSON
    staging_version str
    The most recent version to be activated to the staging network
    type str
    Specifies the type of the include, either 'MICROSERVICES' or 'COMMON_SETTINGS'
    contractId String
    Identifies the contract to which the include is assigned
    groupId String
    Identifies the group to which the include is assigned
    latestVersion Number
    Specifies the most recent version of the include
    name String
    A descriptive name for the include
    productId String
    The product assigned to the include
    productionVersion String
    The most recent version to be activated to the production network
    ruleErrors String
    Rule validation errors
    ruleFormat String
    Indicates the versioned set of features and criteria
    ruleWarnings String
    Rule validation warnings
    rules String
    Property Rules as JSON
    stagingVersion String
    The most recent version to be activated to the staging network
    type String
    Specifies the type of the include, either 'MICROSERVICES' or 'COMMON_SETTINGS'

    Package Details

    Repository
    Akamai pulumi/pulumi-akamai
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the akamai Terraform Provider.
    akamai logo
    Akamai v7.2.0 published on Friday, May 31, 2024 by Pulumi