Templates

• Implements: ros_cdk_oos.datasource.ITemplates

This class encapsulates and extends the ROS resource type DATASOURCE::OOS::TemplatesThe , which type is used to query template lists.

Initializers

from ros_cdk_oos import datasource
datasource.Templates(
  scope: Construct,
  id: str,
  category: typing.Union[str, IResolvable] = None,
  created_by: typing.Union[str, IResolvable] = None,
  created_date_after: typing.Union[str, IResolvable] = None,
  created_date_before: typing.Union[str, IResolvable] = None,
  has_trigger: typing.Union[bool, IResolvable] = None,
  is_example: typing.Union[bool, IResolvable] = None,
  is_favorite: typing.Union[bool, IResolvable] = None,
  refresh_options: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  share_type: typing.Union[str, IResolvable] = None,
  sort_field: typing.Union[str, IResolvable] = None,
  sort_order: typing.Union[str, IResolvable] = None,
  tags: typing.Mapping[typing.Any] = None,
  template_format: typing.Union[str, IResolvable] = None,
  template_name: typing.Union[str, IResolvable] = None,
  template_type: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

category^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property category: The type of the template.

Valid values include TimerTrigger, EventTrigger, AlarmTrigger, and Other.

created_by^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property createdBy: The creator of the template.

created_date_after^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property createdDateAfter: Specifies to query the template that is created at or later than the specified time.The value must be in the YYYY-MM-DDThh:mm:ssZ format.

created_date_before^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property createdDateBefore: Specifies to query the template that is created at or before the specified time.The value must be in the YYYY-MM-DDThh:mm::ssZ format.

has_trigger^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property hasTrigger: Specifies whether to query the template that is configured with a trigger.

is_example^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property isExample: Specifies whether the template is an example template.

is_favorite^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property isFavorite: Specifies whether the template is added to favorites.

refresh_options^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

• Never: Never refresh the datasource resource when the stack is updated.
• Always: Always refresh the datasource resource when the stack is updated. Default is Never.

resource_group_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property resourceGroupId: The ID of the resource group.

share_type^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property shareType: The share type of the template.

Valid values: Public Private

sort_field^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property sortField: The field that is used to sort the templates to be queried.

Valid values: TotalExecutionCount (default): The system sorts the returned templates based on the total number of times that the templates are used. Popularity: The system sorts the returned templates based on the popularity of the templates. TemplateName: The system sorts the returned templates based on the names of the templates. CreatedDate: The system sorts the returned templates based on the points in time when the templates are created. UpdatedDate: The system sorts the returned templates based on the points in time when the templates are updated.

sort_order^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property sortOrder: The order in which you want to sort the results.

Valid values: Ascending: ascending order. Descending: descending order. This is the default value.

tags^Optional

• Type: typing.Mapping[typing.Any]

Property tags: The tag keys and values.

The number of key-value pairs ranges from 1 to 20. Example: {"k1":"k2","k2":"v2"}

template_format^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property templateFormat: The format of the template.

Valid values: JSON YAML

template_name^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property templateName: The name of the template.

template_type^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property templateType: The type of the template.

Valid values: Automation: the template for automated tasks. State: the template for configuration inventories. Package: the template for software packages.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

from ros_cdk_oos import datasource
datasource.Templates.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_template_names^Required

attr_template_names: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute TemplateNames: The list of template_names.

attr_templates^Required

attr_templates: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Templates: The list of templates.

props^Required

props: TemplatesProps

• Type: TemplatesProps

Structs