Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataSafe
  5. SecurityPolicy
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

oci.DataSafe.SecurityPolicy

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

    This resource provides the Security Policy resource in Oracle Cloud Infrastructure Data Safe service.

    Updates the security policy.

    Create SecurityPolicy Resource

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

    Constructor syntax

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

@overload
def SecurityPolicy(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   security_policy_id: Optional[str] = None,
                   compartment_id: Optional[str] = None,
                   defined_tags: Optional[Mapping[str, str]] = None,
                   description: Optional[str] = None,
                   display_name: Optional[str] = None,
                   freeform_tags: Optional[Mapping[str, str]] = None)
    func NewSecurityPolicy(ctx *Context, name string, args SecurityPolicyArgs, opts ...ResourceOption) (*SecurityPolicy, error)
    public SecurityPolicy(string name, SecurityPolicyArgs args, CustomResourceOptions? opts = null)
    public SecurityPolicy(String name, SecurityPolicyArgs args)
public SecurityPolicy(String name, SecurityPolicyArgs args, CustomResourceOptions options)

    type: oci:DataSafe:SecurityPolicy
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 SecurityPolicyArgs
    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 SecurityPolicyArgs
    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 SecurityPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SecurityPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SecurityPolicyArgs
    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 securityPolicyResource = new Oci.DataSafe.SecurityPolicy("securityPolicyResource", new()
{
    SecurityPolicyId = "string",
    CompartmentId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
});

    example, err := DataSafe.NewSecurityPolicy(ctx, "securityPolicyResource", &DataSafe.SecurityPolicyArgs{
	SecurityPolicyId: pulumi.String("string"),
	CompartmentId:    pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var securityPolicyResource = new SecurityPolicy("securityPolicyResource", SecurityPolicyArgs.builder()
    .securityPolicyId("string")
    .compartmentId("string")
    .definedTags(Map.of("string", "string"))
    .description("string")
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .build());

    security_policy_resource = oci.data_safe.SecurityPolicy("securityPolicyResource",
    security_policy_id="string",
    compartment_id="string",
    defined_tags={
        "string": "string",
    },
    description="string",
    display_name="string",
    freeform_tags={
        "string": "string",
    })

    const securityPolicyResource = new oci.datasafe.SecurityPolicy("securityPolicyResource", {
    securityPolicyId: "string",
    compartmentId: "string",
    definedTags: {
        string: "string",
    },
    description: "string",
    displayName: "string",
    freeformTags: {
        string: "string",
    },
});

    type: oci:DataSafe:SecurityPolicy
properties:
    compartmentId: string
    definedTags:
        string: string
    description: string
    displayName: string
    freeformTags:
        string: string
    securityPolicyId: string

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

    SecurityPolicyId string

    The OCID of the security policy resource.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    CompartmentId string
    (Updatable) The OCID of the compartment containing the security policy.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The description of the security policy.
    DisplayName string
    (Updatable) The display name of the security policy. The name does not have to be unique, and it is changeable.
    FreeformTags Dictionary<string, string>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    SecurityPolicyId string

    The OCID of the security policy resource.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    CompartmentId string
    (Updatable) The OCID of the compartment containing the security policy.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The description of the security policy.
    DisplayName string
    (Updatable) The display name of the security policy. The name does not have to be unique, and it is changeable.
    FreeformTags map[string]string
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    securityPolicyId String

    The OCID of the security policy resource.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    (Updatable) The OCID of the compartment containing the security policy.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The description of the security policy.
    displayName String
    (Updatable) The display name of the security policy. The name does not have to be unique, and it is changeable.
    freeformTags Map<String,String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    securityPolicyId string

    The OCID of the security policy resource.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId string
    (Updatable) The OCID of the compartment containing the security policy.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    description string
    (Updatable) The description of the security policy.
    displayName string
    (Updatable) The display name of the security policy. The name does not have to be unique, and it is changeable.
    freeformTags {[key: string]: string}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    security_policy_id str

    The OCID of the security policy resource.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartment_id str
    (Updatable) The OCID of the compartment containing the security policy.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    description str
    (Updatable) The description of the security policy.
    display_name str
    (Updatable) The display name of the security policy. The name does not have to be unique, and it is changeable.
    freeform_tags Mapping[str, str]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    securityPolicyId String

    The OCID of the security policy resource.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    (Updatable) The OCID of the compartment containing the security policy.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The description of the security policy.
    displayName String
    (Updatable) The display name of the security policy. The name does not have to be unique, and it is changeable.
    freeformTags Map<String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    Details about the current state of the security policy in Data Safe.
    State string
    The current state of the security policy.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time that the security policy was created, in the format defined by RFC3339.
    TimeUpdated string
    The last date and time the security policy was updated, in the format defined by RFC3339.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    Details about the current state of the security policy in Data Safe.
    State string
    The current state of the security policy.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time that the security policy was created, in the format defined by RFC3339.
    TimeUpdated string
    The last date and time the security policy was updated, in the format defined by RFC3339.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    Details about the current state of the security policy in Data Safe.
    state String
    The current state of the security policy.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time that the security policy was created, in the format defined by RFC3339.
    timeUpdated String
    The last date and time the security policy was updated, in the format defined by RFC3339.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails string
    Details about the current state of the security policy in Data Safe.
    state string
    The current state of the security policy.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time that the security policy was created, in the format defined by RFC3339.
    timeUpdated string
    The last date and time the security policy was updated, in the format defined by RFC3339.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_details str
    Details about the current state of the security policy in Data Safe.
    state str
    The current state of the security policy.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time that the security policy was created, in the format defined by RFC3339.
    time_updated str
    The last date and time the security policy was updated, in the format defined by RFC3339.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    Details about the current state of the security policy in Data Safe.
    state String
    The current state of the security policy.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time that the security policy was created, in the format defined by RFC3339.
    timeUpdated String
    The last date and time the security policy was updated, in the format defined by RFC3339.

    Look up Existing SecurityPolicy Resource

    Get an existing SecurityPolicy 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?: SecurityPolicyState, opts?: CustomResourceOptions): SecurityPolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        lifecycle_details: Optional[str] = None,
        security_policy_id: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> SecurityPolicy
    func GetSecurityPolicy(ctx *Context, name string, id IDInput, state *SecurityPolicyState, opts ...ResourceOption) (*SecurityPolicy, error)
    public static SecurityPolicy Get(string name, Input<string> id, SecurityPolicyState? state, CustomResourceOptions? opts = null)
    public static SecurityPolicy get(String name, Output<String> id, SecurityPolicyState 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:
    CompartmentId string
    (Updatable) The OCID of the compartment containing the security policy.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The description of the security policy.
    DisplayName string
    (Updatable) The display name of the security policy. The name does not have to be unique, and it is changeable.
    FreeformTags Dictionary<string, string>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    LifecycleDetails string
    Details about the current state of the security policy in Data Safe.
    SecurityPolicyId string

    The OCID of the security policy resource.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    State string
    The current state of the security policy.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time that the security policy was created, in the format defined by RFC3339.
    TimeUpdated string
    The last date and time the security policy was updated, in the format defined by RFC3339.
    CompartmentId string
    (Updatable) The OCID of the compartment containing the security policy.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The description of the security policy.
    DisplayName string
    (Updatable) The display name of the security policy. The name does not have to be unique, and it is changeable.
    FreeformTags map[string]string
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    LifecycleDetails string
    Details about the current state of the security policy in Data Safe.
    SecurityPolicyId string

    The OCID of the security policy resource.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    State string
    The current state of the security policy.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time that the security policy was created, in the format defined by RFC3339.
    TimeUpdated string
    The last date and time the security policy was updated, in the format defined by RFC3339.
    compartmentId String
    (Updatable) The OCID of the compartment containing the security policy.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The description of the security policy.
    displayName String
    (Updatable) The display name of the security policy. The name does not have to be unique, and it is changeable.
    freeformTags Map<String,String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    lifecycleDetails String
    Details about the current state of the security policy in Data Safe.
    securityPolicyId String

    The OCID of the security policy resource.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    state String
    The current state of the security policy.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time that the security policy was created, in the format defined by RFC3339.
    timeUpdated String
    The last date and time the security policy was updated, in the format defined by RFC3339.
    compartmentId string
    (Updatable) The OCID of the compartment containing the security policy.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    description string
    (Updatable) The description of the security policy.
    displayName string
    (Updatable) The display name of the security policy. The name does not have to be unique, and it is changeable.
    freeformTags {[key: string]: string}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    lifecycleDetails string
    Details about the current state of the security policy in Data Safe.
    securityPolicyId string

    The OCID of the security policy resource.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    state string
    The current state of the security policy.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time that the security policy was created, in the format defined by RFC3339.
    timeUpdated string
    The last date and time the security policy was updated, in the format defined by RFC3339.
    compartment_id str
    (Updatable) The OCID of the compartment containing the security policy.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    description str
    (Updatable) The description of the security policy.
    display_name str
    (Updatable) The display name of the security policy. The name does not have to be unique, and it is changeable.
    freeform_tags Mapping[str, str]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    lifecycle_details str
    Details about the current state of the security policy in Data Safe.
    security_policy_id str

    The OCID of the security policy resource.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    state str
    The current state of the security policy.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time that the security policy was created, in the format defined by RFC3339.
    time_updated str
    The last date and time the security policy was updated, in the format defined by RFC3339.
    compartmentId String
    (Updatable) The OCID of the compartment containing the security policy.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The description of the security policy.
    displayName String
    (Updatable) The display name of the security policy. The name does not have to be unique, and it is changeable.
    freeformTags Map<String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    lifecycleDetails String
    Details about the current state of the security policy in Data Safe.
    securityPolicyId String

    The OCID of the security policy resource.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    state String
    The current state of the security policy.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time that the security policy was created, in the format defined by RFC3339.
    timeUpdated String
    The last date and time the security policy was updated, in the format defined by RFC3339.

    Import

    SecurityPolicies can be imported using the id, e.g.

    $ pulumi import oci:DataSafe/securityPolicy:SecurityPolicy test_security_policy "id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-oci