Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Akamai
  3. API Docs
  4. Property
Akamai v7.5.0 published on Friday, Oct 11, 2024 by Pulumi
pulumi/pulumi-akamai

akamai.Property

Explore with Pulumi AI

akamai logo
Akamai v7.5.0 published on Friday, Oct 11, 2024 by Pulumi
pulumi/pulumi-akamai

    Create Property Resource

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

    Constructor syntax

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

@overload
def Property(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             contract_id: Optional[str] = None,
             group_id: Optional[str] = None,
             product_id: Optional[str] = None,
             hostnames: Optional[Sequence[PropertyHostnameArgs]] = None,
             name: Optional[str] = None,
             property_id: Optional[str] = None,
             rule_format: Optional[str] = None,
             rules: Optional[str] = None,
             version_notes: Optional[str] = None)
    func NewProperty(ctx *Context, name string, args PropertyArgs, opts ...ResourceOption) (*Property, error)
    public Property(string name, PropertyArgs args, CustomResourceOptions? opts = null)
    public Property(String name, PropertyArgs args)
public Property(String name, PropertyArgs args, CustomResourceOptions options)

    type: akamai:Property
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 PropertyArgs
    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 PropertyArgs
    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 PropertyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PropertyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PropertyArgs
    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 propertyResource = new Akamai.Property("propertyResource", new()
{
    ContractId = "string",
    GroupId = "string",
    ProductId = "string",
    Hostnames = new[]
    {
        new Akamai.Inputs.PropertyHostnameArgs
        {
            CertProvisioningType = "string",
            CnameFrom = "string",
            CnameTo = "string",
            CertStatuses = new[]
            {
                new Akamai.Inputs.PropertyHostnameCertStatusArgs
                {
                    Hostname = "string",
                    ProductionStatus = "string",
                    StagingStatus = "string",
                    Target = "string",
                },
            },
            CnameType = "string",
            EdgeHostnameId = "string",
        },
    },
    Name = "string",
    PropertyId = "string",
    RuleFormat = "string",
    Rules = "string",
    VersionNotes = "string",
});

    example, err := akamai.NewProperty(ctx, "propertyResource", &akamai.PropertyArgs{
	ContractId: pulumi.String("string"),
	GroupId:    pulumi.String("string"),
	ProductId:  pulumi.String("string"),
	Hostnames: akamai.PropertyHostnameArray{
		&akamai.PropertyHostnameArgs{
			CertProvisioningType: pulumi.String("string"),
			CnameFrom:            pulumi.String("string"),
			CnameTo:              pulumi.String("string"),
			CertStatuses: akamai.PropertyHostnameCertStatusArray{
				&akamai.PropertyHostnameCertStatusArgs{
					Hostname:         pulumi.String("string"),
					ProductionStatus: pulumi.String("string"),
					StagingStatus:    pulumi.String("string"),
					Target:           pulumi.String("string"),
				},
			},
			CnameType:      pulumi.String("string"),
			EdgeHostnameId: pulumi.String("string"),
		},
	},
	Name:         pulumi.String("string"),
	PropertyId:   pulumi.String("string"),
	RuleFormat:   pulumi.String("string"),
	Rules:        pulumi.String("string"),
	VersionNotes: pulumi.String("string"),
})

    var propertyResource = new Property("propertyResource", PropertyArgs.builder()
    .contractId("string")
    .groupId("string")
    .productId("string")
    .hostnames(PropertyHostnameArgs.builder()
        .certProvisioningType("string")
        .cnameFrom("string")
        .cnameTo("string")
        .certStatuses(PropertyHostnameCertStatusArgs.builder()
            .hostname("string")
            .productionStatus("string")
            .stagingStatus("string")
            .target("string")
            .build())
        .cnameType("string")
        .edgeHostnameId("string")
        .build())
    .name("string")
    .propertyId("string")
    .ruleFormat("string")
    .rules("string")
    .versionNotes("string")
    .build());

    property_resource = akamai.Property("propertyResource",
    contract_id="string",
    group_id="string",
    product_id="string",
    hostnames=[{
        "cert_provisioning_type": "string",
        "cname_from": "string",
        "cname_to": "string",
        "cert_statuses": [{
            "hostname": "string",
            "production_status": "string",
            "staging_status": "string",
            "target": "string",
        }],
        "cname_type": "string",
        "edge_hostname_id": "string",
    }],
    name="string",
    property_id="string",
    rule_format="string",
    rules="string",
    version_notes="string")

    const propertyResource = new akamai.Property("propertyResource", {
    contractId: "string",
    groupId: "string",
    productId: "string",
    hostnames: [{
        certProvisioningType: "string",
        cnameFrom: "string",
        cnameTo: "string",
        certStatuses: [{
            hostname: "string",
            productionStatus: "string",
            stagingStatus: "string",
            target: "string",
        }],
        cnameType: "string",
        edgeHostnameId: "string",
    }],
    name: "string",
    propertyId: "string",
    ruleFormat: "string",
    rules: "string",
    versionNotes: "string",
});

    type: akamai:Property
properties:
    contractId: string
    groupId: string
    hostnames:
        - certProvisioningType: string
          certStatuses:
            - hostname: string
              productionStatus: string
              stagingStatus: string
              target: string
          cnameFrom: string
          cnameTo: string
          cnameType: string
          edgeHostnameId: string
    name: string
    productId: string
    propertyId: string
    ruleFormat: string
    rules: string
    versionNotes: string

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

    ContractId string
    Contract ID to be assigned to the Property
    GroupId string
    Group ID to be assigned to the Property
    ProductId string
    Product ID to be assigned to the Property
    Hostnames List<PropertyHostname>
    Name string
    Name to give to the Property (must be unique)
    PropertyId string
    Property ID
    RuleFormat string
    Specify the rule format version (defaults to latest version available when created)
    Rules string
    Property Rules as JSON
    VersionNotes string
    Property version notes
    ContractId string
    Contract ID to be assigned to the Property
    GroupId string
    Group ID to be assigned to the Property
    ProductId string
    Product ID to be assigned to the Property
    Hostnames []PropertyHostnameArgs
    Name string
    Name to give to the Property (must be unique)
    PropertyId string
    Property ID
    RuleFormat string
    Specify the rule format version (defaults to latest version available when created)
    Rules string
    Property Rules as JSON
    VersionNotes string
    Property version notes
    contractId String
    Contract ID to be assigned to the Property
    groupId String
    Group ID to be assigned to the Property
    productId String
    Product ID to be assigned to the Property
    hostnames List<PropertyHostname>
    name String
    Name to give to the Property (must be unique)
    propertyId String
    Property ID
    ruleFormat String
    Specify the rule format version (defaults to latest version available when created)
    rules String
    Property Rules as JSON
    versionNotes String
    Property version notes
    contractId string
    Contract ID to be assigned to the Property
    groupId string
    Group ID to be assigned to the Property
    productId string
    Product ID to be assigned to the Property
    hostnames PropertyHostname[]
    name string
    Name to give to the Property (must be unique)
    propertyId string
    Property ID
    ruleFormat string
    Specify the rule format version (defaults to latest version available when created)
    rules string
    Property Rules as JSON
    versionNotes string
    Property version notes
    contract_id str
    Contract ID to be assigned to the Property
    group_id str
    Group ID to be assigned to the Property
    product_id str
    Product ID to be assigned to the Property
    hostnames Sequence[PropertyHostnameArgs]
    name str
    Name to give to the Property (must be unique)
    property_id str
    Property ID
    rule_format str
    Specify the rule format version (defaults to latest version available when created)
    rules str
    Property Rules as JSON
    version_notes str
    Property version notes
    contractId String
    Contract ID to be assigned to the Property
    groupId String
    Group ID to be assigned to the Property
    productId String
    Product ID to be assigned to the Property
    hostnames List<Property Map>
    name String
    Name to give to the Property (must be unique)
    propertyId String
    Property ID
    ruleFormat String
    Specify the rule format version (defaults to latest version available when created)
    rules String
    Property Rules as JSON
    versionNotes String
    Property version notes

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    LatestVersion int
    Property's current latest version number
    ProductionVersion int
    Property's version currently activated in production (zero when not active in production)
    ReadVersion int
    Required property's version to be read
    RuleErrors List<PropertyRuleError>
    RuleWarnings List<PropertyRuleWarning>
    Rule validation warnings
    StagingVersion int
    Property's version currently activated in staging (zero when not active in staging)
    Id string
    The provider-assigned unique ID for this managed resource.
    LatestVersion int
    Property's current latest version number
    ProductionVersion int
    Property's version currently activated in production (zero when not active in production)
    ReadVersion int
    Required property's version to be read
    RuleErrors []PropertyRuleError
    RuleWarnings []PropertyRuleWarning
    Rule validation warnings
    StagingVersion int
    Property's version currently activated in staging (zero when not active in staging)
    id String
    The provider-assigned unique ID for this managed resource.
    latestVersion Integer
    Property's current latest version number
    productionVersion Integer
    Property's version currently activated in production (zero when not active in production)
    readVersion Integer
    Required property's version to be read
    ruleErrors List<PropertyRuleError>
    ruleWarnings List<PropertyRuleWarning>
    Rule validation warnings
    stagingVersion Integer
    Property's version currently activated in staging (zero when not active in staging)
    id string
    The provider-assigned unique ID for this managed resource.
    latestVersion number
    Property's current latest version number
    productionVersion number
    Property's version currently activated in production (zero when not active in production)
    readVersion number
    Required property's version to be read
    ruleErrors PropertyRuleError[]
    ruleWarnings PropertyRuleWarning[]
    Rule validation warnings
    stagingVersion number
    Property's version currently activated in staging (zero when not active in staging)
    id str
    The provider-assigned unique ID for this managed resource.
    latest_version int
    Property's current latest version number
    production_version int
    Property's version currently activated in production (zero when not active in production)
    read_version int
    Required property's version to be read
    rule_errors Sequence[PropertyRuleError]
    rule_warnings Sequence[PropertyRuleWarning]
    Rule validation warnings
    staging_version int
    Property's version currently activated in staging (zero when not active in staging)
    id String
    The provider-assigned unique ID for this managed resource.
    latestVersion Number
    Property's current latest version number
    productionVersion Number
    Property's version currently activated in production (zero when not active in production)
    readVersion Number
    Required property's version to be read
    ruleErrors List<Property Map>
    ruleWarnings List<Property Map>
    Rule validation warnings
    stagingVersion Number
    Property's version currently activated in staging (zero when not active in staging)

    Look up Existing Property Resource

    Get an existing Property 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?: PropertyState, opts?: CustomResourceOptions): Property
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        contract_id: Optional[str] = None,
        group_id: Optional[str] = None,
        hostnames: Optional[Sequence[PropertyHostnameArgs]] = None,
        latest_version: Optional[int] = None,
        name: Optional[str] = None,
        product_id: Optional[str] = None,
        production_version: Optional[int] = None,
        property_id: Optional[str] = None,
        read_version: Optional[int] = None,
        rule_errors: Optional[Sequence[PropertyRuleErrorArgs]] = None,
        rule_format: Optional[str] = None,
        rule_warnings: Optional[Sequence[PropertyRuleWarningArgs]] = None,
        rules: Optional[str] = None,
        staging_version: Optional[int] = None,
        version_notes: Optional[str] = None) -> Property
    func GetProperty(ctx *Context, name string, id IDInput, state *PropertyState, opts ...ResourceOption) (*Property, error)
    public static Property Get(string name, Input<string> id, PropertyState? state, CustomResourceOptions? opts = null)
    public static Property get(String name, Output<String> id, PropertyState 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
    Contract ID to be assigned to the Property
    GroupId string
    Group ID to be assigned to the Property
    Hostnames List<PropertyHostname>
    LatestVersion int
    Property's current latest version number
    Name string
    Name to give to the Property (must be unique)
    ProductId string
    Product ID to be assigned to the Property
    ProductionVersion int
    Property's version currently activated in production (zero when not active in production)
    PropertyId string
    Property ID
    ReadVersion int
    Required property's version to be read
    RuleErrors List<PropertyRuleError>
    RuleFormat string
    Specify the rule format version (defaults to latest version available when created)
    RuleWarnings List<PropertyRuleWarning>
    Rule validation warnings
    Rules string
    Property Rules as JSON
    StagingVersion int
    Property's version currently activated in staging (zero when not active in staging)
    VersionNotes string
    Property version notes
    ContractId string
    Contract ID to be assigned to the Property
    GroupId string
    Group ID to be assigned to the Property
    Hostnames []PropertyHostnameArgs
    LatestVersion int
    Property's current latest version number
    Name string
    Name to give to the Property (must be unique)
    ProductId string
    Product ID to be assigned to the Property
    ProductionVersion int
    Property's version currently activated in production (zero when not active in production)
    PropertyId string
    Property ID
    ReadVersion int
    Required property's version to be read
    RuleErrors []PropertyRuleErrorArgs
    RuleFormat string
    Specify the rule format version (defaults to latest version available when created)
    RuleWarnings []PropertyRuleWarningArgs
    Rule validation warnings
    Rules string
    Property Rules as JSON
    StagingVersion int
    Property's version currently activated in staging (zero when not active in staging)
    VersionNotes string
    Property version notes
    contractId String
    Contract ID to be assigned to the Property
    groupId String
    Group ID to be assigned to the Property
    hostnames List<PropertyHostname>
    latestVersion Integer
    Property's current latest version number
    name String
    Name to give to the Property (must be unique)
    productId String
    Product ID to be assigned to the Property
    productionVersion Integer
    Property's version currently activated in production (zero when not active in production)
    propertyId String
    Property ID
    readVersion Integer
    Required property's version to be read
    ruleErrors List<PropertyRuleError>
    ruleFormat String
    Specify the rule format version (defaults to latest version available when created)
    ruleWarnings List<PropertyRuleWarning>
    Rule validation warnings
    rules String
    Property Rules as JSON
    stagingVersion Integer
    Property's version currently activated in staging (zero when not active in staging)
    versionNotes String
    Property version notes
    contractId string
    Contract ID to be assigned to the Property
    groupId string
    Group ID to be assigned to the Property
    hostnames PropertyHostname[]
    latestVersion number
    Property's current latest version number
    name string
    Name to give to the Property (must be unique)
    productId string
    Product ID to be assigned to the Property
    productionVersion number
    Property's version currently activated in production (zero when not active in production)
    propertyId string
    Property ID
    readVersion number
    Required property's version to be read
    ruleErrors PropertyRuleError[]
    ruleFormat string
    Specify the rule format version (defaults to latest version available when created)
    ruleWarnings PropertyRuleWarning[]
    Rule validation warnings
    rules string
    Property Rules as JSON
    stagingVersion number
    Property's version currently activated in staging (zero when not active in staging)
    versionNotes string
    Property version notes
    contract_id str
    Contract ID to be assigned to the Property
    group_id str
    Group ID to be assigned to the Property
    hostnames Sequence[PropertyHostnameArgs]
    latest_version int
    Property's current latest version number
    name str
    Name to give to the Property (must be unique)
    product_id str
    Product ID to be assigned to the Property
    production_version int
    Property's version currently activated in production (zero when not active in production)
    property_id str
    Property ID
    read_version int
    Required property's version to be read
    rule_errors Sequence[PropertyRuleErrorArgs]
    rule_format str
    Specify the rule format version (defaults to latest version available when created)
    rule_warnings Sequence[PropertyRuleWarningArgs]
    Rule validation warnings
    rules str
    Property Rules as JSON
    staging_version int
    Property's version currently activated in staging (zero when not active in staging)
    version_notes str
    Property version notes
    contractId String
    Contract ID to be assigned to the Property
    groupId String
    Group ID to be assigned to the Property
    hostnames List<Property Map>
    latestVersion Number
    Property's current latest version number
    name String
    Name to give to the Property (must be unique)
    productId String
    Product ID to be assigned to the Property
    productionVersion Number
    Property's version currently activated in production (zero when not active in production)
    propertyId String
    Property ID
    readVersion Number
    Required property's version to be read
    ruleErrors List<Property Map>
    ruleFormat String
    Specify the rule format version (defaults to latest version available when created)
    ruleWarnings List<Property Map>
    Rule validation warnings
    rules String
    Property Rules as JSON
    stagingVersion Number
    Property's version currently activated in staging (zero when not active in staging)
    versionNotes String
    Property version notes

    Supporting Types

    PropertyHostname, PropertyHostnameArgs

    PropertyHostnameCertStatus, PropertyHostnameCertStatusArgs

    PropertyRuleError, PropertyRuleErrorArgs

    BehaviorName string
    Detail string
    ErrorLocation string
    Instance string
    StatusCode int
    Title string
    Type string
    BehaviorName string
    Detail string
    ErrorLocation string
    Instance string
    StatusCode int
    Title string
    Type string
    behaviorName String
    detail String
    errorLocation String
    instance String
    statusCode Integer
    title String
    type String
    behaviorName string
    detail string
    errorLocation string
    instance string
    statusCode number
    title string
    type string
    behaviorName String
    detail String
    errorLocation String
    instance String
    statusCode Number
    title String
    type String

    PropertyRuleWarning, PropertyRuleWarningArgs

    BehaviorName string
    Detail string
    ErrorLocation string
    Instance string
    StatusCode int
    Title string
    Type string
    BehaviorName string
    Detail string
    ErrorLocation string
    Instance string
    StatusCode int
    Title string
    Type string
    behaviorName String
    detail String
    errorLocation String
    instance String
    statusCode Integer
    title String
    type String
    behaviorName string
    detail string
    errorLocation string
    instance string
    statusCode number
    title string
    type string
    behaviorName String
    detail String
    errorLocation String
    instance String
    statusCode Number
    title String
    type String

    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.5.0 published on Friday, Oct 11, 2024 by Pulumi
    pulumi/pulumi-akamai