ibm.CmValidation
Explore with Pulumi AI
Provides a resource for ibm_cm_validation. This allows ibm.CmValidation to be created, updated and deleted.
Static credentials
You can provide your static credentials by adding the ibmcloud_api_key
, iaas_classic_username
, and iaas_classic_api_key
arguments in the IBM Cloud provider block.
Usage:
provider "ibm" {
ibmcloud_api_key = ""
iaas_classic_username = ""
iaas_classic_api_key = ""
}
Environment variables
You can provide your credentials by exporting the IC_API_KEY
, IAAS_CLASSIC_USERNAME
, and IAAS_CLASSIC_API_KEY
environment variables, representing your IBM Cloud platform API key, IBM Cloud Classic Infrastructure (SoftLayer) user name, and IBM Cloud infrastructure API key, respectively.
provider "ibm" {}
Usage:
export IC_API_KEY="api_key"
export IAAS_CLASSIC_USERNAME="iaas_classic_username"
export IAAS_CLASSIC_API_KEY="api_key"
pulumi preview
Note:
- Create or find your
ibmcloud_api_key
andiaas_classic_api_key
here.
- Select
My IBM Cloud API Keys
option from view dropdown foribmcloud_api_key
- Select
Classic Infrastructure API Keys
option from view dropdown foriaas_classic_api_key
- For iaas_classic_username
- Go to Users
- Click on user.
- Find user name in the
VPN password
section underUser Details
tab
For more informaton, see here.
Create CmValidation Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CmValidation(name: string, args: CmValidationArgs, opts?: CustomResourceOptions);
@overload
def CmValidation(resource_name: str,
args: CmValidationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CmValidation(resource_name: str,
opts: Optional[ResourceOptions] = None,
version_locator: Optional[str] = None,
cm_validation_id: Optional[str] = None,
environment_variables: Optional[Sequence[CmValidationEnvironmentVariableArgs]] = None,
mark_version_consumable: Optional[bool] = None,
override_values: Optional[Mapping[str, str]] = None,
region: Optional[str] = None,
revalidate_if_validated: Optional[bool] = None,
schematics: Optional[CmValidationSchematicsArgs] = None,
x_auth_refresh_token: Optional[str] = None)
func NewCmValidation(ctx *Context, name string, args CmValidationArgs, opts ...ResourceOption) (*CmValidation, error)
public CmValidation(string name, CmValidationArgs args, CustomResourceOptions? opts = null)
public CmValidation(String name, CmValidationArgs args)
public CmValidation(String name, CmValidationArgs args, CustomResourceOptions options)
type: ibm:CmValidation
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 CmValidationArgs
- 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 CmValidationArgs
- 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 CmValidationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CmValidationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CmValidationArgs
- 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 cmValidationResource = new Ibm.CmValidation("cmValidationResource", new()
{
VersionLocator = "string",
CmValidationId = "string",
EnvironmentVariables = new[]
{
new Ibm.Inputs.CmValidationEnvironmentVariableArgs
{
Name = "string",
Secure = false,
Value = "string",
},
},
MarkVersionConsumable = false,
OverrideValues =
{
{ "string", "string" },
},
Region = "string",
RevalidateIfValidated = false,
Schematics = new Ibm.Inputs.CmValidationSchematicsArgs
{
Description = "string",
Name = "string",
Region = "string",
ResourceGroupId = "string",
Tags = new[]
{
"string",
},
TerraformVersion = "string",
},
});
example, err := ibm.NewCmValidation(ctx, "cmValidationResource", &ibm.CmValidationArgs{
VersionLocator: pulumi.String("string"),
CmValidationId: pulumi.String("string"),
EnvironmentVariables: ibm.CmValidationEnvironmentVariableArray{
&ibm.CmValidationEnvironmentVariableArgs{
Name: pulumi.String("string"),
Secure: pulumi.Bool(false),
Value: pulumi.String("string"),
},
},
MarkVersionConsumable: pulumi.Bool(false),
OverrideValues: pulumi.StringMap{
"string": pulumi.String("string"),
},
Region: pulumi.String("string"),
RevalidateIfValidated: pulumi.Bool(false),
Schematics: &ibm.CmValidationSchematicsArgs{
Description: pulumi.String("string"),
Name: pulumi.String("string"),
Region: pulumi.String("string"),
ResourceGroupId: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
TerraformVersion: pulumi.String("string"),
},
})
var cmValidationResource = new CmValidation("cmValidationResource", CmValidationArgs.builder()
.versionLocator("string")
.cmValidationId("string")
.environmentVariables(CmValidationEnvironmentVariableArgs.builder()
.name("string")
.secure(false)
.value("string")
.build())
.markVersionConsumable(false)
.overrideValues(Map.of("string", "string"))
.region("string")
.revalidateIfValidated(false)
.schematics(CmValidationSchematicsArgs.builder()
.description("string")
.name("string")
.region("string")
.resourceGroupId("string")
.tags("string")
.terraformVersion("string")
.build())
.build());
cm_validation_resource = ibm.CmValidation("cmValidationResource",
version_locator="string",
cm_validation_id="string",
environment_variables=[{
"name": "string",
"secure": False,
"value": "string",
}],
mark_version_consumable=False,
override_values={
"string": "string",
},
region="string",
revalidate_if_validated=False,
schematics={
"description": "string",
"name": "string",
"region": "string",
"resource_group_id": "string",
"tags": ["string"],
"terraform_version": "string",
})
const cmValidationResource = new ibm.CmValidation("cmValidationResource", {
versionLocator: "string",
cmValidationId: "string",
environmentVariables: [{
name: "string",
secure: false,
value: "string",
}],
markVersionConsumable: false,
overrideValues: {
string: "string",
},
region: "string",
revalidateIfValidated: false,
schematics: {
description: "string",
name: "string",
region: "string",
resourceGroupId: "string",
tags: ["string"],
terraformVersion: "string",
},
});
type: ibm:CmValidation
properties:
cmValidationId: string
environmentVariables:
- name: string
secure: false
value: string
markVersionConsumable: false
overrideValues:
string: string
region: string
revalidateIfValidated: false
schematics:
description: string
name: string
region: string
resourceGroupId: string
tags:
- string
terraformVersion: string
versionLocator: string
CmValidation 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 CmValidation resource accepts the following input properties:
- Version
Locator string - Version locator - the version that will be validated.
- Cm
Validation stringId - Environment
Variables List<CmValidation Environment Variable> - List of environment variables to pass to Schematics. Nested scheme for environment_variables:
- Mark
Version boolConsumable - If the version should be marked as consumable after validation, aka "ready to share".
- Override
Values Dictionary<string, string> - Map of override values to be used in validation.
- Region string
- Validation region.
- Revalidate
If boolValidated - If the version should be revalidated if it is already validated.
- Schematics
Cm
Validation Schematics - Other values to pass to Schematics. Nested scheme for schematics:
- XAuth
Refresh stringToken - Authentication token used to submit validation job.
- Version
Locator string - Version locator - the version that will be validated.
- Cm
Validation stringId - Environment
Variables []CmValidation Environment Variable Args - List of environment variables to pass to Schematics. Nested scheme for environment_variables:
- Mark
Version boolConsumable - If the version should be marked as consumable after validation, aka "ready to share".
- Override
Values map[string]string - Map of override values to be used in validation.
- Region string
- Validation region.
- Revalidate
If boolValidated - If the version should be revalidated if it is already validated.
- Schematics
Cm
Validation Schematics Args - Other values to pass to Schematics. Nested scheme for schematics:
- XAuth
Refresh stringToken - Authentication token used to submit validation job.
- version
Locator String - Version locator - the version that will be validated.
- cm
Validation StringId - environment
Variables List<CmValidation Environment Variable> - List of environment variables to pass to Schematics. Nested scheme for environment_variables:
- mark
Version BooleanConsumable - If the version should be marked as consumable after validation, aka "ready to share".
- override
Values Map<String,String> - Map of override values to be used in validation.
- region String
- Validation region.
- revalidate
If BooleanValidated - If the version should be revalidated if it is already validated.
- schematics
Cm
Validation Schematics - Other values to pass to Schematics. Nested scheme for schematics:
- x
Auth StringRefresh Token - Authentication token used to submit validation job.
- version
Locator string - Version locator - the version that will be validated.
- cm
Validation stringId - environment
Variables CmValidation Environment Variable[] - List of environment variables to pass to Schematics. Nested scheme for environment_variables:
- mark
Version booleanConsumable - If the version should be marked as consumable after validation, aka "ready to share".
- override
Values {[key: string]: string} - Map of override values to be used in validation.
- region string
- Validation region.
- revalidate
If booleanValidated - If the version should be revalidated if it is already validated.
- schematics
Cm
Validation Schematics - Other values to pass to Schematics. Nested scheme for schematics:
- x
Auth stringRefresh Token - Authentication token used to submit validation job.
- version_
locator str - Version locator - the version that will be validated.
- cm_
validation_ strid - environment_
variables Sequence[CmValidation Environment Variable Args] - List of environment variables to pass to Schematics. Nested scheme for environment_variables:
- mark_
version_ boolconsumable - If the version should be marked as consumable after validation, aka "ready to share".
- override_
values Mapping[str, str] - Map of override values to be used in validation.
- region str
- Validation region.
- revalidate_
if_ boolvalidated - If the version should be revalidated if it is already validated.
- schematics
Cm
Validation Schematics Args - Other values to pass to Schematics. Nested scheme for schematics:
- x_
auth_ strrefresh_ token - Authentication token used to submit validation job.
- version
Locator String - Version locator - the version that will be validated.
- cm
Validation StringId - environment
Variables List<Property Map> - List of environment variables to pass to Schematics. Nested scheme for environment_variables:
- mark
Version BooleanConsumable - If the version should be marked as consumable after validation, aka "ready to share".
- override
Values Map<String> - Map of override values to be used in validation.
- region String
- Validation region.
- revalidate
If BooleanValidated - If the version should be revalidated if it is already validated.
- schematics Property Map
- Other values to pass to Schematics. Nested scheme for schematics:
- x
Auth StringRefresh Token - Authentication token used to submit validation job.
Outputs
All input properties are implicitly available as output properties. Additionally, the CmValidation resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Operation string - (String) Last operation (e.g. submit_deployment, generate_installer, install_offering.
- Message string
- (String) Any message needing to be conveyed as part of the validation job.
- Requested string
- (String) Data and time of last validation request.
- State string
- (String) Current validation state - , in_progress, valid, invalid, expired.
- Validated string
- (String) Data and time of last successful validation.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Operation string - (String) Last operation (e.g. submit_deployment, generate_installer, install_offering.
- Message string
- (String) Any message needing to be conveyed as part of the validation job.
- Requested string
- (String) Data and time of last validation request.
- State string
- (String) Current validation state - , in_progress, valid, invalid, expired.
- Validated string
- (String) Data and time of last successful validation.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Operation String - (String) Last operation (e.g. submit_deployment, generate_installer, install_offering.
- message String
- (String) Any message needing to be conveyed as part of the validation job.
- requested String
- (String) Data and time of last validation request.
- state String
- (String) Current validation state - , in_progress, valid, invalid, expired.
- validated String
- (String) Data and time of last successful validation.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Operation string - (String) Last operation (e.g. submit_deployment, generate_installer, install_offering.
- message string
- (String) Any message needing to be conveyed as part of the validation job.
- requested string
- (String) Data and time of last validation request.
- state string
- (String) Current validation state - , in_progress, valid, invalid, expired.
- validated string
- (String) Data and time of last successful validation.
- id str
- The provider-assigned unique ID for this managed resource.
- last_
operation str - (String) Last operation (e.g. submit_deployment, generate_installer, install_offering.
- message str
- (String) Any message needing to be conveyed as part of the validation job.
- requested str
- (String) Data and time of last validation request.
- state str
- (String) Current validation state - , in_progress, valid, invalid, expired.
- validated str
- (String) Data and time of last successful validation.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Operation String - (String) Last operation (e.g. submit_deployment, generate_installer, install_offering.
- message String
- (String) Any message needing to be conveyed as part of the validation job.
- requested String
- (String) Data and time of last validation request.
- state String
- (String) Current validation state - , in_progress, valid, invalid, expired.
- validated String
- (String) Data and time of last successful validation.
Look up Existing CmValidation Resource
Get an existing CmValidation 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?: CmValidationState, opts?: CustomResourceOptions): CmValidation
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
cm_validation_id: Optional[str] = None,
environment_variables: Optional[Sequence[CmValidationEnvironmentVariableArgs]] = None,
last_operation: Optional[str] = None,
mark_version_consumable: Optional[bool] = None,
message: Optional[str] = None,
override_values: Optional[Mapping[str, str]] = None,
region: Optional[str] = None,
requested: Optional[str] = None,
revalidate_if_validated: Optional[bool] = None,
schematics: Optional[CmValidationSchematicsArgs] = None,
state: Optional[str] = None,
validated: Optional[str] = None,
version_locator: Optional[str] = None,
x_auth_refresh_token: Optional[str] = None) -> CmValidation
func GetCmValidation(ctx *Context, name string, id IDInput, state *CmValidationState, opts ...ResourceOption) (*CmValidation, error)
public static CmValidation Get(string name, Input<string> id, CmValidationState? state, CustomResourceOptions? opts = null)
public static CmValidation get(String name, Output<String> id, CmValidationState state, CustomResourceOptions options)
resources: _: type: ibm:CmValidation get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Cm
Validation stringId - Environment
Variables List<CmValidation Environment Variable> - List of environment variables to pass to Schematics. Nested scheme for environment_variables:
- Last
Operation string - (String) Last operation (e.g. submit_deployment, generate_installer, install_offering.
- Mark
Version boolConsumable - If the version should be marked as consumable after validation, aka "ready to share".
- Message string
- (String) Any message needing to be conveyed as part of the validation job.
- Override
Values Dictionary<string, string> - Map of override values to be used in validation.
- Region string
- Validation region.
- Requested string
- (String) Data and time of last validation request.
- Revalidate
If boolValidated - If the version should be revalidated if it is already validated.
- Schematics
Cm
Validation Schematics - Other values to pass to Schematics. Nested scheme for schematics:
- State string
- (String) Current validation state - , in_progress, valid, invalid, expired.
- Validated string
- (String) Data and time of last successful validation.
- Version
Locator string - Version locator - the version that will be validated.
- XAuth
Refresh stringToken - Authentication token used to submit validation job.
- Cm
Validation stringId - Environment
Variables []CmValidation Environment Variable Args - List of environment variables to pass to Schematics. Nested scheme for environment_variables:
- Last
Operation string - (String) Last operation (e.g. submit_deployment, generate_installer, install_offering.
- Mark
Version boolConsumable - If the version should be marked as consumable after validation, aka "ready to share".
- Message string
- (String) Any message needing to be conveyed as part of the validation job.
- Override
Values map[string]string - Map of override values to be used in validation.
- Region string
- Validation region.
- Requested string
- (String) Data and time of last validation request.
- Revalidate
If boolValidated - If the version should be revalidated if it is already validated.
- Schematics
Cm
Validation Schematics Args - Other values to pass to Schematics. Nested scheme for schematics:
- State string
- (String) Current validation state - , in_progress, valid, invalid, expired.
- Validated string
- (String) Data and time of last successful validation.
- Version
Locator string - Version locator - the version that will be validated.
- XAuth
Refresh stringToken - Authentication token used to submit validation job.
- cm
Validation StringId - environment
Variables List<CmValidation Environment Variable> - List of environment variables to pass to Schematics. Nested scheme for environment_variables:
- last
Operation String - (String) Last operation (e.g. submit_deployment, generate_installer, install_offering.
- mark
Version BooleanConsumable - If the version should be marked as consumable after validation, aka "ready to share".
- message String
- (String) Any message needing to be conveyed as part of the validation job.
- override
Values Map<String,String> - Map of override values to be used in validation.
- region String
- Validation region.
- requested String
- (String) Data and time of last validation request.
- revalidate
If BooleanValidated - If the version should be revalidated if it is already validated.
- schematics
Cm
Validation Schematics - Other values to pass to Schematics. Nested scheme for schematics:
- state String
- (String) Current validation state - , in_progress, valid, invalid, expired.
- validated String
- (String) Data and time of last successful validation.
- version
Locator String - Version locator - the version that will be validated.
- x
Auth StringRefresh Token - Authentication token used to submit validation job.
- cm
Validation stringId - environment
Variables CmValidation Environment Variable[] - List of environment variables to pass to Schematics. Nested scheme for environment_variables:
- last
Operation string - (String) Last operation (e.g. submit_deployment, generate_installer, install_offering.
- mark
Version booleanConsumable - If the version should be marked as consumable after validation, aka "ready to share".
- message string
- (String) Any message needing to be conveyed as part of the validation job.
- override
Values {[key: string]: string} - Map of override values to be used in validation.
- region string
- Validation region.
- requested string
- (String) Data and time of last validation request.
- revalidate
If booleanValidated - If the version should be revalidated if it is already validated.
- schematics
Cm
Validation Schematics - Other values to pass to Schematics. Nested scheme for schematics:
- state string
- (String) Current validation state - , in_progress, valid, invalid, expired.
- validated string
- (String) Data and time of last successful validation.
- version
Locator string - Version locator - the version that will be validated.
- x
Auth stringRefresh Token - Authentication token used to submit validation job.
- cm_
validation_ strid - environment_
variables Sequence[CmValidation Environment Variable Args] - List of environment variables to pass to Schematics. Nested scheme for environment_variables:
- last_
operation str - (String) Last operation (e.g. submit_deployment, generate_installer, install_offering.
- mark_
version_ boolconsumable - If the version should be marked as consumable after validation, aka "ready to share".
- message str
- (String) Any message needing to be conveyed as part of the validation job.
- override_
values Mapping[str, str] - Map of override values to be used in validation.
- region str
- Validation region.
- requested str
- (String) Data and time of last validation request.
- revalidate_
if_ boolvalidated - If the version should be revalidated if it is already validated.
- schematics
Cm
Validation Schematics Args - Other values to pass to Schematics. Nested scheme for schematics:
- state str
- (String) Current validation state - , in_progress, valid, invalid, expired.
- validated str
- (String) Data and time of last successful validation.
- version_
locator str - Version locator - the version that will be validated.
- x_
auth_ strrefresh_ token - Authentication token used to submit validation job.
- cm
Validation StringId - environment
Variables List<Property Map> - List of environment variables to pass to Schematics. Nested scheme for environment_variables:
- last
Operation String - (String) Last operation (e.g. submit_deployment, generate_installer, install_offering.
- mark
Version BooleanConsumable - If the version should be marked as consumable after validation, aka "ready to share".
- message String
- (String) Any message needing to be conveyed as part of the validation job.
- override
Values Map<String> - Map of override values to be used in validation.
- region String
- Validation region.
- requested String
- (String) Data and time of last validation request.
- revalidate
If BooleanValidated - If the version should be revalidated if it is already validated.
- schematics Property Map
- Other values to pass to Schematics. Nested scheme for schematics:
- state String
- (String) Current validation state - , in_progress, valid, invalid, expired.
- validated String
- (String) Data and time of last successful validation.
- version
Locator String - Version locator - the version that will be validated.
- x
Auth StringRefresh Token - Authentication token used to submit validation job.
Supporting Types
CmValidationEnvironmentVariable, CmValidationEnvironmentVariableArgs
CmValidationSchematics, CmValidationSchematicsArgs
- Description string
- Description for the schematics workspace.
- Name string
- Name for the schematics workspace.
- Region string
- Region to use for the schematics installation.
- Resource
Group stringId - The resource group ID.
- List<string>
- List of tags for the schematics workspace.
- Terraform
Version string
- Description string
- Description for the schematics workspace.
- Name string
- Name for the schematics workspace.
- Region string
- Region to use for the schematics installation.
- Resource
Group stringId - The resource group ID.
- []string
- List of tags for the schematics workspace.
- Terraform
Version string
- description String
- Description for the schematics workspace.
- name String
- Name for the schematics workspace.
- region String
- Region to use for the schematics installation.
- resource
Group StringId - The resource group ID.
- List<String>
- List of tags for the schematics workspace.
- terraform
Version String
- description string
- Description for the schematics workspace.
- name string
- Name for the schematics workspace.
- region string
- Region to use for the schematics installation.
- resource
Group stringId - The resource group ID.
- string[]
- List of tags for the schematics workspace.
- terraform
Version string
- description str
- Description for the schematics workspace.
- name str
- Name for the schematics workspace.
- region str
- Region to use for the schematics installation.
- resource_
group_ strid - The resource group ID.
- Sequence[str]
- List of tags for the schematics workspace.
- terraform_
version str
- description String
- Description for the schematics workspace.
- name String
- Name for the schematics workspace.
- region String
- Region to use for the schematics installation.
- resource
Group StringId - The resource group ID.
- List<String>
- List of tags for the schematics workspace.
- terraform
Version String
Package Details
- Repository
- ibm ibm-cloud/terraform-provider-ibm
- License
- Notes
- This Pulumi package is based on the
ibm
Terraform Provider.