1. Packages
  2. Mso Provider
  3. API Docs
  4. Site
mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet

mso.Site

Explore with Pulumi AI

mso logo
mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet

    Create Site Resource

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

    Constructor syntax

    new Site(name: string, args: SiteArgs, opts?: CustomResourceOptions);
    @overload
    def Site(resource_name: str,
             args: SiteArgs,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def Site(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             apic_site_id: Optional[str] = None,
             cloud_providers: Optional[Sequence[str]] = None,
             labels: Optional[Sequence[str]] = None,
             location: Optional[Mapping[str, str]] = None,
             login_domain: Optional[str] = None,
             maintenance_mode: Optional[bool] = None,
             name: Optional[str] = None,
             password: Optional[str] = None,
             platform: Optional[str] = None,
             site_id: Optional[str] = None,
             urls: Optional[Sequence[str]] = None,
             username: Optional[str] = None)
    func NewSite(ctx *Context, name string, args SiteArgs, opts ...ResourceOption) (*Site, error)
    public Site(string name, SiteArgs args, CustomResourceOptions? opts = null)
    public Site(String name, SiteArgs args)
    public Site(String name, SiteArgs args, CustomResourceOptions options)
    
    type: mso:Site
    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 SiteArgs
    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 SiteArgs
    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 SiteArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SiteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SiteArgs
    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 siteResource = new Mso.Site("siteResource", new()
    {
        ApicSiteId = "string",
        CloudProviders = new[]
        {
            "string",
        },
        Labels = new[]
        {
            "string",
        },
        Location = 
        {
            { "string", "string" },
        },
        LoginDomain = "string",
        MaintenanceMode = false,
        Name = "string",
        Password = "string",
        Platform = "string",
        SiteId = "string",
        Urls = new[]
        {
            "string",
        },
        Username = "string",
    });
    
    example, err := mso.NewSite(ctx, "siteResource", &mso.SiteArgs{
    	ApicSiteId: pulumi.String("string"),
    	CloudProviders: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Labels: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Location: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	LoginDomain:     pulumi.String("string"),
    	MaintenanceMode: pulumi.Bool(false),
    	Name:            pulumi.String("string"),
    	Password:        pulumi.String("string"),
    	Platform:        pulumi.String("string"),
    	SiteId:          pulumi.String("string"),
    	Urls: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Username: pulumi.String("string"),
    })
    
    var siteResource = new Site("siteResource", SiteArgs.builder()
        .apicSiteId("string")
        .cloudProviders("string")
        .labels("string")
        .location(Map.of("string", "string"))
        .loginDomain("string")
        .maintenanceMode(false)
        .name("string")
        .password("string")
        .platform("string")
        .siteId("string")
        .urls("string")
        .username("string")
        .build());
    
    site_resource = mso.Site("siteResource",
        apic_site_id="string",
        cloud_providers=["string"],
        labels=["string"],
        location={
            "string": "string",
        },
        login_domain="string",
        maintenance_mode=False,
        name="string",
        password="string",
        platform="string",
        site_id="string",
        urls=["string"],
        username="string")
    
    const siteResource = new mso.Site("siteResource", {
        apicSiteId: "string",
        cloudProviders: ["string"],
        labels: ["string"],
        location: {
            string: "string",
        },
        loginDomain: "string",
        maintenanceMode: false,
        name: "string",
        password: "string",
        platform: "string",
        siteId: "string",
        urls: ["string"],
        username: "string",
    });
    
    type: mso:Site
    properties:
        apicSiteId: string
        cloudProviders:
            - string
        labels:
            - string
        location:
            string: string
        loginDomain: string
        maintenanceMode: false
        name: string
        password: string
        platform: string
        siteId: string
        urls:
            - string
        username: string
    

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

    ApicSiteId string
    CloudProviders List<string>
    Labels List<string>
    Location Dictionary<string, string>
    LoginDomain string
    MaintenanceMode bool
    Name string
    Password string
    Platform string
    SiteId string
    Urls List<string>
    Username string
    ApicSiteId string
    CloudProviders []string
    Labels []string
    Location map[string]string
    LoginDomain string
    MaintenanceMode bool
    Name string
    Password string
    Platform string
    SiteId string
    Urls []string
    Username string
    apicSiteId String
    cloudProviders List<String>
    labels List<String>
    location Map<String,String>
    loginDomain String
    maintenanceMode Boolean
    name String
    password String
    platform String
    siteId String
    urls List<String>
    username String
    apicSiteId string
    cloudProviders string[]
    labels string[]
    location {[key: string]: string}
    loginDomain string
    maintenanceMode boolean
    name string
    password string
    platform string
    siteId string
    urls string[]
    username string
    apic_site_id str
    cloud_providers Sequence[str]
    labels Sequence[str]
    location Mapping[str, str]
    login_domain str
    maintenance_mode bool
    name str
    password str
    platform str
    site_id str
    urls Sequence[str]
    username str
    apicSiteId String
    cloudProviders List<String>
    labels List<String>
    location Map<String>
    loginDomain String
    maintenanceMode Boolean
    name String
    password String
    platform String
    siteId String
    urls List<String>
    username String

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Site Resource

    Get an existing Site 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?: SiteState, opts?: CustomResourceOptions): Site
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            apic_site_id: Optional[str] = None,
            cloud_providers: Optional[Sequence[str]] = None,
            labels: Optional[Sequence[str]] = None,
            location: Optional[Mapping[str, str]] = None,
            login_domain: Optional[str] = None,
            maintenance_mode: Optional[bool] = None,
            name: Optional[str] = None,
            password: Optional[str] = None,
            platform: Optional[str] = None,
            site_id: Optional[str] = None,
            urls: Optional[Sequence[str]] = None,
            username: Optional[str] = None) -> Site
    func GetSite(ctx *Context, name string, id IDInput, state *SiteState, opts ...ResourceOption) (*Site, error)
    public static Site Get(string name, Input<string> id, SiteState? state, CustomResourceOptions? opts = null)
    public static Site get(String name, Output<String> id, SiteState state, CustomResourceOptions options)
    resources:  _:    type: mso:Site    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.
    The following state arguments are supported:
    ApicSiteId string
    CloudProviders List<string>
    Labels List<string>
    Location Dictionary<string, string>
    LoginDomain string
    MaintenanceMode bool
    Name string
    Password string
    Platform string
    SiteId string
    Urls List<string>
    Username string
    ApicSiteId string
    CloudProviders []string
    Labels []string
    Location map[string]string
    LoginDomain string
    MaintenanceMode bool
    Name string
    Password string
    Platform string
    SiteId string
    Urls []string
    Username string
    apicSiteId String
    cloudProviders List<String>
    labels List<String>
    location Map<String,String>
    loginDomain String
    maintenanceMode Boolean
    name String
    password String
    platform String
    siteId String
    urls List<String>
    username String
    apicSiteId string
    cloudProviders string[]
    labels string[]
    location {[key: string]: string}
    loginDomain string
    maintenanceMode boolean
    name string
    password string
    platform string
    siteId string
    urls string[]
    username string
    apic_site_id str
    cloud_providers Sequence[str]
    labels Sequence[str]
    location Mapping[str, str]
    login_domain str
    maintenance_mode bool
    name str
    password str
    platform str
    site_id str
    urls Sequence[str]
    username str
    apicSiteId String
    cloudProviders List<String>
    labels List<String>
    location Map<String>
    loginDomain String
    maintenanceMode Boolean
    name String
    password String
    platform String
    siteId String
    urls List<String>
    username String

    Package Details

    Repository
    mso ciscodevnet/terraform-provider-mso
    License
    Notes
    This Pulumi package is based on the mso Terraform Provider.
    mso logo
    mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet